---

NSURLCredential Class Reference

Overview

NSURLCredential is an immutable object representing an authentication credential consisting of the user name, a password and the type of persistent storage to use, if any.

Adopted Protocols

• copyWithZone:

Tasks

Creating a Credential

• + credentialWithUser:password:persistence:
• – initWithUser:password:persistence:

Getting Credential Properties

• – hasPassword
• – password
• – persistence
• – user

Class Methods

credentialWithUser:password:persistence:

Creates and returns an NSURLCredential object with a given user name and password using a given persistence setting.

+ (NSURLCredential *)credentialWithUser:(NSString *)user password:(NSString *)password persistence:(NSURLCredentialPersistence)persistence

Parameters

user

The user for the credential.

password

The password for user.

persistence

The persistence setting for the credential.

Return Value

An NSURLCredential object with user name user, password password, and using persistence setting persistence.

Discussion

If persistence is NSURLCredentialPersistencePermanent the credential is stored in the keychain.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

See Also

• – initWithUser:password:persistence:

Declared In

NSURLCredential.h

Instance Methods

hasPassword

Returns a Boolean value that indicates whether the receiver has a password.

- (BOOL)hasPassword

Return Value

YES if the receiver has a password, NO otherwise.

Discussion

This method does not attempt to retrieve the password.

If this credential's password is stored in the user’s keychain, password may return NO even if this method returns YES, since getting the password may fail, or the user may refuse access.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

Declared In

NSURLCredential.h

initWithUser:password:persistence:

Returns an NSURLCredential object initialized with a given user name and password using a given persistence setting.

- (id)initWithUser:(NSString *)user password:(NSString *)password persistence:(NSURLCredentialPersistence)persistence

Parameters

user

The user for the credential.

password

The password for user.

persistence

The persistence setting for the credential.

Return Value

An NSURLCredential object initialized with user name user, password password, and using persistence setting persistence.

Discussion

If persistence is NSURLCredentialPersistencePermanent the credential is stored in the keychain.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

See Also

• + credentialWithUser:password:persistence:

Declared In

NSURLCredential.h

password

Returns the receiver’s password.

- (NSString *)password

Return Value

The receiver’s password.

Discussion

If the password is stored in the user’s keychain, this method may result in prompting the user for access.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

See Also

• – hasPassword

Declared In

NSURLCredential.h

persistence

Returns the receiver’s persistence setting.

- (NSURLCredentialPersistence)persistence

Return Value

The receiver’s persistence setting.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

Declared In

NSURLCredential.h

user

Returns the receiver’s user name.

- (NSString *)user

Return Value

The receiver’s user name.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

Declared In

NSURLCredential.h

Constants

NSURLCredentialPersistence

These constants specify how long the credential will be kept.

typedef enum {
   NSURLCredentialPersistenceNone,
   NSURLCredentialPersistenceForSession,
   NSURLCredentialPersistencePermanent
} NSURLCredentialPersistence;

Constants

NSURLCredentialPersistenceNone

Credential won't be stored.

Available in Mac OS X v10.2 and later.

Declared in NSURLCredential.h.

NSURLCredentialPersistenceForSession

Credential will be stored only for this session.

Available in Mac OS X v10.2 and later.

Declared in NSURLCredential.h.

NSURLCredentialPersistencePermanent

Credential will be stored in the user’s keychain and shared with other applications.

Available in Mac OS X v10.2 and later.

Declared in NSURLCredential.h.

Availability

• Available in Mac OS X v10.2 with Safari 1.0 installed.
• Available in Mac OS X v10.2.7 and later.

Declared In

NSURLCredential.h

---