Type Aliases Reference


                    
                    
                    APICategoryBehavior

Behavior of the API category that clients will use

Declaration

Swift

public typealias APICategoryBehavior =
    APICategoryRESTBehavior &
    APICategoryGraphQLBehavior &
    APICategoryInterceptorBehavior &
    APICategoryReachabilityBehavior &
    APICategoryAuthProviderFactoryBehavior


                    
                    
                    GraphQLTask

Declaration

Swift

public typealias GraphQLTask<R> = GraphQLOperation<R>.TaskAdapter where R : Decodable


                    
                    
                    RESTTask

Declaration

Swift

public typealias RESTTask = RESTOperation.TaskAdapter


                    
                    
                    RawGraphQLResponse

Raw GraphQL Response String

Declaration

Swift

public typealias RawGraphQLResponse = String


                    
                    
                    GraphQLResponse

GraphQL Response Result

Declaration

Swift

public typealias GraphQLResponse<ResponseType: Decodable> =
    Result<ResponseType, GraphQLResponseError<ResponseType>>


                    
                    
                    AnalyticsProperties

Analytics category properties

Declaration

Swift

public typealias AnalyticsProperties = [String : AnalyticsPropertyValue]


                    
                    
                    AuthUIPresentationAnchor

Declaration

Swift

public typealias AuthUIPresentationAnchor = ASPresentationAnchor


                    
                    
                    AdditionalInfo

Declaration

Swift

public typealias AdditionalInfo = [String : String]


                    
                    
                    AllowedMFATypes

Set of allowed MFA types that would be used for continuing sign in during MFA selection step

Declaration

Swift

public typealias AllowedMFATypes = Set<MFAType>


                    
                    
                    AvailableAuthFactorTypes

Set of available factors that would be used for continuing/confirming sign in

Declaration

Swift

public typealias AvailableAuthFactorTypes = Set<AuthFactorType>


                    
                    
                    UserId

Declaration

Swift

public typealias UserId = String


                    
                    
                    Session

Declaration

Swift

public typealias Session = String


                    
                    
                    Destination

Declaration

Swift

public typealias Destination = String


                    
                    
                    DataStoreResult

Enum that holds the results of a DataStore operation.

Seealso

DataStoreCallback

Declaration

Swift

public typealias DataStoreResult<Success> = Result<Success, DataStoreError>


                    
                    
                    DataStoreCallback

Function type of every DataStore asynchronous API.

Declaration

Swift

public typealias DataStoreCallback<Result> = (DataStoreResult<Result>) -> Void


                    
                    
                    DataStoreCategoryBehavior

Declaration

Swift

public typealias DataStoreCategoryBehavior = DataStoreBaseBehavior & DataStoreSubscribeBehavior


                    
                    
                    AuthRules

Warning

Although this has public access, it is intended for internal use and should not be used directly by host applications. The behavior of this may change without warning.

Declaration

Swift

public typealias AuthRules = [AuthRule]


                    
                    
                    ModelFieldName

Warning

Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.

Declaration

Swift

public typealias ModelFieldName = String


                    
                    
                    ModelFields

Warning

Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.

Declaration

Swift

public typealias ModelFields = [String : ModelField]


                    
                    
                    ModelName

Warning

Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.

Declaration

Swift

public typealias ModelName = String


                    
                    
                    DefaultModelIdentifier

Convenience type for a ModelIdentifier with a ModelIdentifierFormat.Default format

Declaration

Swift

public typealias DefaultModelIdentifier<M> = ModelIdentifier<M, ModelIdentifierFormat.Default> where M : Model


                    
                    
                    HubPublisher

Declaration

Swift

public typealias HubPublisher = AnyPublisher<HubPayload, Never>


                    
                    
                    HubListener

Convenience typealias defining a closure that can be used to listen to Hub messages

Declaration

Swift

public typealias HubListener = (HubPayload) -> Void


                    
                    
                    HubFilter

Convenience typealias defining a closure that can be used to filter Hub messages

Declaration

Swift

public typealias HubFilter = (HubPayload) -> Bool


                    
                    
                    HubPayloadEventName

Declaration

Swift

public typealias HubPayloadEventName = String


                    
                    
                    LogLevel

Declaration

Swift

public typealias LogLevel = Amplify.LogLevel


                    
                    
                    StorageDownloadDataTask

Tag: StorageDownloadDataTask

Declaration

Swift

public typealias StorageDownloadDataTask = AmplifyInProcessReportingOperationTaskAdapter<StorageDownloadDataRequest,
                                                                                                  Progress,
                                                                                                  Data,
                                                                                                  StorageError>


                    
                    
                    StorageDownloadFileTask

Tag: StorageDownloadFileTask

Declaration

Swift

public typealias StorageDownloadFileTask = AmplifyInProcessReportingOperationTaskAdapter<StorageDownloadFileRequest,
                                                                                         Progress,
                                                                                         Void,
                                                                                         StorageError>


                    
                    
                    StorageUploadDataTask

Tag: StorageUploadDataTask

Declaration

Swift

public typealias StorageUploadDataTask = AmplifyInProcessReportingOperationTaskAdapter<StorageUploadDataRequest,
                                                                                       Progress,
                                                                                       String,
                                                                                       StorageError>


                    
                    
                    StorageUploadFileTask

Tag: StorageUploadFileTask

Declaration

Swift

public typealias StorageUploadFileTask = AmplifyInProcessReportingOperationTaskAdapter<StorageUploadFileRequest,
                                                                                       Progress,
                                                                                       String,
                                                                                       StorageError>


                    
                    
                    ProgressListener

Convenience typealias for a callback invoked with an asynchronous operation’s Progress

Tag: ProgressListener

Declaration

Swift

public typealias ProgressListener = (Progress) -> Void


                    
                    
                    IdentityIDPathResolver

Declaration

Swift

public typealias IdentityIDPathResolver = (String) -> String


                    
                    
                    PluginKey

Convenience typealias to clarify when Strings are being used as plugin keys

Declaration

Swift

public typealias PluginKey = String


                    
                    
                    WeakAmplifyAsyncSequenceRef

Declaration

Swift

public typealias WeakAmplifyAsyncSequenceRef<Element> = WeakRef<AmplifyAsyncSequence<Element>>


                    
                    
                    WeakAmplifyAsyncThrowingSequenceRef

Declaration

Swift

public typealias WeakAmplifyAsyncThrowingSequenceRef<Element> = WeakRef<AmplifyAsyncThrowingSequence<Element>>


                    
                    
                    ErrorDescription

See: AmplifyError.errorDescription

Tag: ErrorDescription

Declaration

Swift

public typealias ErrorDescription = String


                    
                    
                    RecoverySuggestion

See: AmplifyError.recoverySuggestion

Tag: RecoverySuggestion

Declaration

Swift

public typealias RecoverySuggestion = String


                    
                    
                    ErrorName

Tag: ErrorName

Declaration

Swift

public typealias ErrorName = String


                    
                    
                    Field

Tag: Field

Declaration

Swift

public typealias Field = String

Key

Tag: Key

Declaration

Swift

public typealias Key = String


                    
                    
                    TargetIdentityId

Tag: TargetIdentityId

Declaration

Swift

public typealias TargetIdentityId = String


                    
                    
                    BasicClosure

Convenience typealias

Declaration

Swift

public typealias BasicClosure = () -> Void


                    
                    
                    BasicThrowableClosure

Declaration

Swift

public typealias BasicThrowableClosure = () throws -> Void


                    
                    
                    AmplifyCancellable

Unique name for Cancellable which handles a name conflict with the Combine framework.

Declaration

Swift

public typealias AmplifyCancellable = Cancellable