AWSCognitoCredentialsProviderHelper Protocol Reference

Conforms to AWSIdentityProvider
AWSIdentityProviderManager
Declared in AWSIdentityProvider.h

Overview

AWSCognitoCredentialsProviderHelper provides a Cognito specific identity provider. Cognito Identity providers are associated with an identity pool. If the identity pool supports authenticated access, multiple logins may be added to link to the Cognito identity.

  identityPoolId required method

The identity pool for this provider. Used to when making calls to the Amazon Cognito service

@property (nonatomic, strong, readonly) NSString *identityPoolId

Declared In

AWSIdentityProvider.h

  identityId required method

The identity id as determined by the Amazon Cognito service

@property (nonatomic, strong, nullable) NSString *identityId

Declared In

AWSIdentityProvider.h

  identityProviderManager required method

@property (nonatomic, strong, readonly, nullable) id<AWSIdentityProviderManager> identityProviderManager

Declared In

AWSIdentityProvider.h

– getIdentityId required method

Get/retrieve the identity id for this provider. If an identity id is already set on this provider, no remote call is made and the identity will be returned as a result of the AWSTask (the identityId is also available as a property). If no identityId is set on this provider, one will be retrieved from the service.

- (AWSTask<NSString*> *)getIdentityId

Declared In

AWSIdentityProvider.h

– isAuthenticated required method

Is this provider considered ‘authenticated’. By default, only returns YES if logins is set.

- (BOOL)isAuthenticated

Declared In

AWSIdentityProvider.h

– clear required method

Clear saved values for identityId, token, and logins.

- (void)clear

Declared In

AWSIdentityProvider.h