Protocols

The following protocols are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentityInteractiveAuthenticationDelegate <NSObject>
    @optional
    /**
     Initialize ui to prompt end user for username and password
     */
    -(id<AWSCognitoIdentityPasswordAuthentication>) startPasswordAuthentication;
    
    /**
     Initialize ui to prompt end user for multifactor authentication code
     */
    -(id<AWSCognitoIdentityMultiFactorAuthentication>) startMultiFactorAuthentication;
    
    /**
     Initialize ui to prompt end user to remember this device
     */
    -(id<AWSCognitoIdentityRememberDevice>) startRememberDevice;
    
    /**
     Initialize ui to prompt end user to set a new password and specify profile information as part of sign in
     */
    -(id<AWSCognitoIdentityNewPasswordRequired>) startNewPasswordRequired;
    
    /**
     Initialize ui to prompt end user for custom authentication flow
     */
    -(id<AWSCognitoIdentityCustomAuthentication>) startCustomAuthentication;
    
    /**
     Initialize ui to prompt end user to setup a software mfa token */
    -(id<AWSCognitoIdentitySoftwareMfaSetupRequired>) startSoftwareMfaSetupRequired;
    
    /**
     Initialize ui to prompt end user to pick desired mfa */
    -(id<AWSCognitoIdentitySelectMfa>) startSelectMfa;
    
    @end

    Swift

    protocol AWSCognitoIdentityInteractiveAuthenticationDelegate : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentityPasswordAuthentication <NSObject>
    /**
     Obtain username and password from end user.
     @param authenticationInput input details including last known username
     @param passwordAuthenticationCompletionSource set passwordAuthenticationCompletionSource.result
     with the username and password received from the end user.
     */
    -(void) getPasswordAuthenticationDetails: (AWSCognitoIdentityPasswordAuthenticationInput *) authenticationInput  passwordAuthenticationCompletionSource: (AWSTaskCompletionSource<AWSCognitoIdentityPasswordAuthenticationDetails *> *) passwordAuthenticationCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompletePasswordAuthenticationStepWithError:(NSError* _Nullable) error;
    @end

    Swift

    protocol AWSCognitoIdentityPasswordAuthentication : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentityMultiFactorAuthentication <NSObject>
    /**
     Obtain mfa code from the end user
     @param authenticationInput details about the deliveryMedium and masked destination for where the code was sent
     @param mfaCodeCompletionSource set mfaCodeCompletionSource.result with the mfa code from end user
     */
    -(void) getMultiFactorAuthenticationCode: (AWSCognitoIdentityMultifactorAuthenticationInput *) authenticationInput mfaCodeCompletionSource: (AWSTaskCompletionSource<NSString *> *) mfaCodeCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompleteMultifactorAuthenticationStepWithError:(NSError* _Nullable) error;
    @end

    Swift

    protocol AWSCognitoIdentityMultiFactorAuthentication : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentityCustomAuthentication <NSObject>
    
    
    /**
     Obtain input for a custom challenge from the end user
     @param authenticationInput details the challenge including the challenge name and inputs
     @param customAuthCompletionSource set customAuthCompletionSource.result with the challenge answers from the end user
     */
    -(void) getCustomChallengeDetails: (AWSCognitoIdentityCustomAuthenticationInput *) authenticationInput customAuthCompletionSource: (AWSTaskCompletionSource<AWSCognitoIdentityCustomChallengeDetails *> *) customAuthCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompleteCustomAuthenticationStepWithError:(NSError* _Nullable) error;
    
    
    @end

    Swift

    protocol AWSCognitoIdentityCustomAuthentication : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentityRememberDevice <NSObject>
    
    /**
     Obtain whether to remember this device or not
     @param rememberDeviceCompletionSource set customAuthCompletionSource.result with YES or NO answer from the end user
     */
    -(void) getRememberDevice: (AWSTaskCompletionSource<NSNumber *> *) rememberDeviceCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompleteRememberDeviceStepWithError:(NSError* _Nullable) error;
    @end

    Swift

    protocol AWSCognitoIdentityRememberDevice : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentityNewPasswordRequired <NSObject>
    
    /**
     Obtain a new password and specify profile information as part of sign in from the end user
     @param newPasswordRequiredInput user profile and required attributes of the end user
     @param newPasswordRequiredCompletionSource set newPasswordRequiredCompletionSource.result with the new password and any attribute updates from the end user
     */
    -(void) getNewPasswordDetails: (AWSCognitoIdentityNewPasswordRequiredInput *) newPasswordRequiredInput newPasswordRequiredCompletionSource: (AWSTaskCompletionSource<AWSCognitoIdentityNewPasswordRequiredDetails *> *) newPasswordRequiredCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompleteNewPasswordStepWithError:(NSError* _Nullable) error;
    
    
    @end

    Swift

    protocol AWSCognitoIdentityNewPasswordRequired : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentitySoftwareMfaSetupRequired <NSObject>
    
    /**
     Obtain information about end user's software mfa
     @param softwareMfaSetupInput contains secret code necessary for end user to configure their software mfa
     @param softwareMfaSetupRequiredCompletionSource set softwareMfaSetupRequiredCompletionSource.result with the secret code and device name from the end user
     */
    -(void) getSoftwareMfaSetupDetails: (AWSCognitoIdentitySoftwareMfaSetupRequiredInput *) softwareMfaSetupInput softwareMfaSetupRequiredCompletionSource: (AWSTaskCompletionSource<AWSCognitoIdentitySoftwareMfaSetupRequiredDetails *> *) softwareMfaSetupRequiredCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompleteMfaSetupStepWithError:(NSError* _Nullable) error;
    
    
    @end

    Swift

    protocol AWSCognitoIdentitySoftwareMfaSetupRequired : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol AWSCognitoIdentitySelectMfa <NSObject>
    
    /**
     Obtain which mfa end user wants to provide
     @param selectMfaInput contains which mfas are available
     @param selectMfaCompletionSource set selectMfaCompletionSource.result with the mfa end user picked
     */
    -(void) getSelectMfaDetails: (AWSCognitoIdentitySelectMfaInput *) selectMfaInput selectMfaCompletionSource: (AWSTaskCompletionSource<AWSCognitoIdentitySelectMfaDetails *> *) selectMfaCompletionSource;
    /**
     This step completed, usually either display an error to the end user or dismiss ui
     @param error the error if any that occured
     */
    -(void) didCompleteSelectMfaStepWithError:(NSError* _Nullable) error;
    
    
    @end

    Swift

    protocol AWSCognitoIdentitySelectMfa : NSObjectProtocol