AWSCognitoUserPoolsSignInProvider Class Reference

Inherits from	NSObject
Conforms to	AWSSignInProvider
Declared in	AWSCognitoUserPoolsSignInProvider.h AWSCognitoUserPoolsSignInProvider.m

Overview

AWSCognitoUserPoolsSignInProvider adopts the AWSSignInProvider protocol.

It works with the AWS Cognito User Pools SDK internally.

Other Methods

`+ setupUserPoolWithId:cognitoIdentityUserPoolAppClientId:cognitoIdentityUserPoolAppClientSecret:region:`

Registers the cognito pool with specified configuration. The pool object can be accessed by using the CognitoIdentityUserPoolForKey: method using AWSCognitoUserPoolsSignInProviderKey as the identifier key.

+ (void)setupUserPoolWithId:(NSString *)cognitoIdentityUserPoolId cognitoIdentityUserPoolAppClientId:(NSString *)cognitoIdentityUserPoolAppClientId cognitoIdentityUserPoolAppClientSecret:(NSString *)cognitoIdentityUserPoolAppClientSecret region:(AWSRegionType)region

Parameters

`cognitoIdentityUserPoolId`	The Cognito Identity User Pool Id
`cognitoIdentityUserPoolAppClientId`	The Cognito Identity User Pool Client Id
`cognitoIdentityUserPoolAppClientSecret`	The Cognito Identity User Pool Client Secret
`region`	The Cognito Identity User Pool Service Region

Declared In

AWSCognitoUserPoolsSignInProvider.h

`+ sharedInstance`

Fetches the shared instance for AWSCognitoUserPoolsSignInProvider. The method setupUserPoolWithId:cognitoIdentityUserPoolAppClientId:cognitoIdentityUserPoolAppClientSecret:region has to be called once before accessing the shared instance.

+ (instancetype)sharedInstance

Return Value

the single instance of AWSCognitoUserPoolsSignInProvider

Declared In

AWSCognitoUserPoolsSignInProvider.h

`– setInteractiveAuthDelegate:`

Set the instance of the class adopting the AWSCognitoIdentityInteractiveAuthenticationDelegate protocol of Cognito Idp SDK.

- (void)setInteractiveAuthDelegate:(id)interactiveAuthDelegate

Parameters

`interactiveAuthDelegate`	A class adopting the `AWSCognitoIdentityInteractiveAuthenticationDelegate` protocol

Declared In

AWSCognitoUserPoolsSignInProvider.h

`– isLoggedIn`

Returns the status of the current user pool user.

- (BOOL)isLoggedIn

Return Value

YES if the user is signed in.

Declared In

AWSCognitoUserPoolsSignInProvider.h

`– setUserName:`

Sets the userName value of the signed-in user into a persistent store. Should be called on a successful login to set the user name which is used by AWSIdentityManager.

- (void)setUserName:(NSString *)userName

Parameters

`userName`	the user name of the signed-in user

Declared In

AWSCognitoUserPoolsSignInProvider.h

`– setImageURL:`

Sets the imageURL value of the signed-in user into a persistent store. Should be called on a successful login to set the user name which is used by AWSIdentityManager.

- (void)setImageURL:(NSURL *)imageURL

Parameters

`imageURL`	the image URL for a picture of the signed-in user

Declared In

AWSCognitoUserPoolsSignInProvider.h

Extension Methods

`userName`

The User Name of a user.

@property (strong, nonatomic) NSString *userName

Declared In

AWSSignInProvider.h

`imageURL`

The URL for profile image of a user.

@property (strong, nonatomic) NSURL *imageURL

Declared In

AWSSignInProvider.h