SFIdentityCoordinator Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | SFIdentityCoordinator.h |
Overview
The SFIdentityCoordinator class is used to retrieve identity data from the ID endpoint of the Salesforce service. This data will be based on the requesting user, and the OAuth app credentials he/she is using to request this information.
Internal interface for the SFIdentityCoordinator.
Other Methods
– initWithCredentials:
The designated initializer of SFIdentityCoordinator. Creates an instance with the specified OAuth credentials.
- (id)initWithCredentials:(SFOAuthCredentials *)credentialsParameters
credentials |
The OAuth credentials used to query the identity service. At a minimum, the OAuth credentials must specify a value for accessToken and instanceUrl. |
|---|
Declared In
SFIdentityCoordinator.h
– initiateIdentityDataRetrieval
Begins the identity request. This request is asynchronous. Implement the SFIdentityCoordinatorDelegate protocol to receive events related to the identity response from the service.
- (void)initiateIdentityDataRetrievalDeclared In
SFIdentityCoordinator.h
– cancelRetrieval
Cancels a request in progress.
- (void)cancelRetrievalDeclared In
SFIdentityCoordinator.h
credentials
The OAuth credentials associated with this instance.
@property (nonatomic, strong, nullable) SFOAuthCredentials *credentialsDeclared In
SFIdentityCoordinator.h
idData
The SFIdentityData that will be populated with the response data from the service.
@property (nonatomic, strong, nullable) SFIdentityData *idDataDeclared In
SFIdentityCoordinator.h
delegate
The SFIdentityCoordinatorDelegate property to set for receiving information about the request. This property must be set prior to initiating an identity request.
@property (nonatomic, weak) id<SFIdentityCoordinatorDelegate> delegateDeclared In
SFIdentityCoordinator.h
timeout
The amount of time, in seconds, to attempt the request, before it times out. If not set, the default value is represented by the kSFIdentityRequestDefaultTimeoutSeconds property.
@property (nonatomic, assign) NSTimeInterval timeoutDeclared In
SFIdentityCoordinator.h
Extension Methods
retrievingData
Whether or not a request is already in progress.
@property (assign) BOOL retrievingDataDeclared In
SFIdentityCoordinator+Internal.h
session
The NSURLSession associated with the ID request.
@property (nonatomic, strong, nullable) NSURLSession *sessionDeclared In
SFIdentityCoordinator+Internal.h
oauthSessionRefresher
The OAuth sesssion refresher to use if the identity request fails with expired credentials.
@property (nonatomic, strong, nullable) SFOAuthSessionRefresher *oauthSessionRefresherDeclared In
SFIdentityCoordinator+Internal.h
typeToCodeDict
Dictionary mapping error codes to their respective types.
@property (strong, nonatomic, readonly) NSDictionary *typeToCodeDictDeclared In
SFIdentityCoordinator+Internal.h
– notifyDelegateOfSuccess
Triggers the success notifictation to the delegate.
- (void)notifyDelegateOfSuccessDeclared In
SFIdentityCoordinator+Internal.h
– notifyDelegateOfFailure:
Triggers the failure notification and error to the delegate.
- (void)notifyDelegateOfFailure:(NSError *)errorDeclared In
SFIdentityCoordinator+Internal.h
– sendRequest
Sends the request to the identity service, and processes the response.
- (void)sendRequestDeclared In
SFIdentityCoordinator+Internal.h
– processResponse:
Process a completed response from the service, populating the ID data.
- (void)processResponse:(NSData *)responseDataDeclared In
SFIdentityCoordinator+Internal.h
– cleanupData
Cleans up the in-process properties and vars, once a request is completed.
- (void)cleanupDataDeclared In
SFIdentityCoordinator+Internal.h
– errorWithType:description:
Creates an NSError instance based on type and description, for notifying the delegate of a failure.
- (NSError *)errorWithType:(NSString *)type description:(NSString *)descriptionDeclared In
SFIdentityCoordinator+Internal.h