Type Aliases

The following type aliases are available globally.

  • Behavior of the API category that clients will use

    Declaration

    Swift

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

  • Raw GraphQL Response String

    Declaration

    Swift

    public typealias RawGraphQLResponse = String

  • GraphQL Response Result

    Declaration

    Swift

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

  • Analytics category properties

    Declaration

    Swift

    public typealias AnalyticsProperties = [String : AnalyticsPropertyValue]

  • Declaration

    Swift

    public typealias AuthUIPresentationAnchor = UIWindow

  • Declaration

    Swift

    public typealias AdditionalInfo = [String : String]

  • Declaration

    Swift

    public typealias Destination = String

  • Enum that holds the results of a DataStore operation.

    Seealso

    DataStoreCallback

    Declaration

    Swift

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

  • Function type of every DataStore asynchronous API.

    Declaration

    Swift

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

  • Declaration

    Swift

    public typealias DataStorePublisher<Output> = AnyPublisher<Output, DataStoreError>

  • Declaration

    Swift

    public typealias DataStoreCategoryBehavior = DataStoreBaseBehavior & DataStoreSubscribeBehavior

  • 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]

  • 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

  • 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]

  • 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

  • Convenience type for a ModelIdentifier with a ModelIdentifierFormat.Default format

    Declaration

    Swift

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

  • Declaration

    Swift

    public typealias HubPublisher = AnyPublisher<HubPayload, Never>

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

    Declaration

    Swift

    public typealias HubListener = (HubPayload) -> Void

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

    Declaration

    Swift

    public typealias HubFilter = (HubPayload) -> Bool

  • Declaration

    Swift

    public typealias HubPayloadEventName = String

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

    Declaration

    Swift

    public typealias ProgressListener = (Progress) -> Void

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

    Declaration

    Swift

    public typealias PluginKey = String

  • Convenience typealias to disambiguate positional parameters of AmplifyErrors

    Declaration

    Swift

    public typealias ErrorDescription = String

  • Convenience typealias to disambiguate positional parameters of AmplifyErrors

    Declaration

    Swift

    public typealias RecoverySuggestion = String

  • Declaration

    Swift

    public typealias ErrorName = String

  • Declaration

    Swift

    public typealias Field = String
  • Key

    Declaration

    Swift

    public typealias Key = String

  • Declaration

    Swift

    public typealias TargetIdentityId = String

  • Convenience typealias

    Declaration

    Swift

    public typealias BasicClosure = () -> Void

  • Declaration

    Swift

    public typealias BasicThrowableClosure = () throws -> Void

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

    Declaration

    Swift

    public typealias AmplifyCancellable = Cancellable