AWSCognitoCredentialsProviderHelper

Objective-C

@protocol AWSCognitoCredentialsProviderHelper <AWSIdentityProvider,
                                               AWSIdentityProviderManager>

Swift

protocol AWSCognitoCredentialsProviderHelperProtocol : AWSIdentityProvider, AWSIdentityProviderManager

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.

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

    Declaration

    Objective-C

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

    Swift

    var identityPoolId: String { get }
  • The identity id as determined by the Amazon Cognito service

    Declaration

    Objective-C

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

    Swift

    var identityId: String? { get set }
  • Declaration

    Objective-C

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

    Swift

    var identityProviderManager: AWSIdentityProviderManager? { get }
  • 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.

    Declaration

    Objective-C

    - (nonnull AWSTask<NSString *> *)getIdentityId;

    Swift

    func getIdentityId() -> AWSTask
  • Is this provider considered ‘authenticated’. By default, only returns YES if logins is set.

    Declaration

    Objective-C

    - (BOOL)isAuthenticated;

    Swift

    func isAuthenticated() -> Bool
  • Clear saved values for identityId, token, and logins.

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()