Constants

The following constants are available globally.

  • Deprecated

    Use AWSCognitoSDKVersion instead.

    Undocumented

    Declaration

    Objective-C

    extern double AWSCognitoVersionNumber

    Swift

    var AWSCognitoVersionNumber: Double

  • Deprecated

    Use AWSCognitoSDKVersion instead.

    Undocumented

    Declaration

    Objective-C

    extern const unsigned char AWSCognitoVersionString[]

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString *const AWSCognitoSDKVersion

    Swift

    let AWSCognitoSDKVersion: String

  • Posted when the synchronization is started. The notification sender is an instance of AWSCognitoClient. The userInfo contains the dataset name. @discussion This notification is posted once per synchronization. The notification is posted on the Grand Central Dispatch DISPATCH_QUEUE_PRIORITY_DEFAULT queue. The user interface should not be modified on the thread.

    Declaration

    Objective-C

    extern NSString *const _Nonnull AWSCognitoDidStartSynchronizeNotification

    Swift

    static let AWSCognitoDidStartSynchronize: NSNotification.Name

  • Posted when the synchronization is finished with or without errors. The notification sender is an instance of AWSCognitoClient. The userInfo contains the dataset name. @discussion This notification is posted once per synchronization. The notification is posted on the Grand Central Dispatch DISPATCH_QUEUE_PRIORITY_DEFAULT queue. The user interface should not be modified on the thread.

    Declaration

    Objective-C

    extern NSString *const _Nonnull AWSCognitoDidEndSynchronizeNotification

    Swift

    static let AWSCognitoDidEndSynchronize: NSNotification.Name

  • Posted when values are changed to the value from the remote data store. The notification sender is an instance of AWSCognitoClient. The userInfo contains the dataset name and an NSArray of changed keys. @discussion This notification may be posted multiple times per synchronization. The notification is posted on the Grand Central Dispatch DISPATCH_QUEUE_PRIORITY_DEFAULT queue. The user interface should not be modified on the thread.

    Declaration

    Objective-C

    extern NSString
    *const _Nonnull AWSCognitoDidChangeLocalValueFromRemoteNotification

    Swift

    static let AWSCognitoDidChangeLocalValueFromRemote: NSNotification.Name

  • Posted when locally changed values are pushed to the remote store. The notification sender is an instance of AWSCognitoClient. The userInfo contains the dataset name and an NSArray of changed keys. @discussion This notification may be posted multiple times per synchronization. The notification is posted on the Grand Central Dispatch DISPATCH_QUEUE_PRIORITY_DEFAULT queue. The user interface should not be modified on the thread.

    Declaration

    Objective-C

    extern NSString *const _Nonnull AWSCognitoDidChangeRemoteValueNotification

    Swift

    static let AWSCognitoDidChangeRemoteValue: NSNotification.Name

  • Posted when the synchronization for the for the dataset failed. The notification sender is an instance of AWSCognitoClient. The userInfo contains the dataset name and error. @discussion This notification may be posted multiple times per synchronization. The notification is posted on the Grand Central Dispatch DISPATCH_QUEUE_PRIORITY_DEFAULT queue. The user interface should not be modified on the thread.

    Declaration

    Objective-C

    extern NSString *const _Nonnull AWSCognitoDidFailToSynchronizeNotification

    Swift

    static let AWSCognitoDidFailToSynchronize: NSNotification.Name

  • The error domain for AWSCognito errors.

    • AWSCognitoErrorUnknown - Unknow error.
    • AWSCognitoErrorRemoteDataStorageFailed - The Amazon Cognito call temporarily failed.
    • AWSCognitoErrorInvalidDataValue - The Amazon Cognito call failed. The value for the key is invalid and has been deleted from the local database.
    • AWSCognitoErrorDataSizeLimitExceeded - The Amazon Cognito call failed. A dataset has exceeded the max dataset size.
    • AWSCognitoErrorLocalDataStorageFailed - The SQLite call failed.
    • AWSCognitoErrorIllegalArgument - The input value is invalid.
    • AWSCognitoErrorConflictRetriesExhausted - The number of attempts to resolve a conflict has exceeded the max number of retries.
    • AWSCognitoErrorWiFiNotAvailable - WiFi is required and not currently available.
    • AWSCognitoErrorDeviceNotRegistered - The device has not been registered yet.
    • AWSCognitoErrorSyncAlreadyPending - This sync is unecessary, there is already a pending sync.
    • AWSCognitoErrorTimedOutWaitingForInFlightSync - There is a in flight sync that took over 5 minutes to complete, so this one was cancelled.

    Declaration

    Objective-C

    extern NSString *const _Nonnull AWSCognitoErrorDomain

    Swift

    let AWSCognitoErrorDomain: String

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString *const AWSCognitoSyncErrorDomain

    Swift

    let AWSCognitoSyncErrorDomain: String

  • Undocumented

    Declaration

    Objective-C

    extern NSString *const _Nonnull AWSCognitoSyncSDKVersion

    Swift

    let AWSCognitoSyncSDKVersion: String