Type Definitions Reference


                    
                    
                    SMIConversationEntryStatus

Describes a set of known statuses applied to an SMIConversationEntry object. Possible values:

Declaration

Objective-C

typedef NSString *SMIConversationEntryStatus

Swift

struct ConversationEntryStatus : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIConversationEntryTypes

An enum that describes a set of known conversation entry types. Possible values:

Declaration

Objective-C

typedef NSString *SMIConversationEntryTypes

Swift

struct ConversationEntryTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIConversationFormatTypes

An enum that describes a set of known conversation entry formats. Possible values:

Declaration

Objective-C

typedef NSString *SMIConversationFormatTypes

Swift

struct ConversationFormatTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIDataOperationCompletion

Completion for data store operations.

Declaration

Objective-C

typedef void (^SMIDataOperationCompletion)(NSError *_Nullable __strong)

Swift

typealias DataOperationCompletion = (Error?) -> Void

Parameters


                                error

Any errors associated with this operation. nil if successful.


                    
                    
                    SMIFailureTypes

An enum which describes a set of routing failure types. Possible values: *SMIFailureTypesNone *SMIFailureTypesUnknown

Declaration

Objective-C

typedef NSString *SMIFailureTypes

Swift

struct FailureTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIFileFetchCompletion

File fetch completion information.

Declaration

Objective-C

typedef void (^SMIFileFetchCompletion)(NSError *_Nullable __strong)


                    
                    
                    SMIHiddenPreChatValueCompletion

Completion block for hidden pre-chat values.

Declaration

Objective-C

typedef void (^SMIHiddenPreChatValueCompletion)(
    NSArray<id<SMIHiddenPreChatField>> *__strong)

Swift

typealias HiddenPreChatValueCompletion = ([HiddenPreChatField]?) -> Void


                    
                    
                    SMILoggingCategory

Logging category information.

Declaration

Objective-C

typedef NSString *SMILoggingCategory

Swift

struct LoggingCategory : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIMessageReason

An enum that describes possible message reasons. Possible values:

Declaration

Objective-C

typedef NSString *SMIMessageReason

Swift

struct MessageReason : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMINetworkConnectivityState

The network connectivity status. Possible values:

Declaration

Objective-C

typedef NSString *SMINetworkConnectivityState

Swift

struct NetworkConnectivityState : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMINetworkMimeTypes

Network MIME type. Possible values:

Declaration

Objective-C

typedef NSString *const SMINetworkMimeTypes

Swift

struct NetworkMimeTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIParticipantChangedOperationTypes

An enum which describes a set of participant changed operations. Possible values:

Declaration

Objective-C

typedef NSString *SMIParticipantChangedOperationTypes

Swift

struct ParticipantChangedOperationTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIParticipantRole

Participant roles. Possible values:

Declaration

Objective-C

typedef NSString *const SMIParticipantRole

Swift

struct ParticipantRole : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIPreChatConfigurationFormTypes

The pre-chat form type. Possible values:

SMIPreChatConfigurationFormTypePreChat

Declaration

Objective-C

typedef NSString *SMIPreChatConfigurationFormTypes

Swift

struct SMIPreChatConfigurationFormTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIPreChatFieldTypes

The pre-chat field type. Possible values:

Declaration

Objective-C

typedef NSString *SMIPreChatFieldTypes

Swift

struct PreChatFieldTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIFullQueryCompletion

Completion block for queries returning SMITextMessage objects.

Declaration

Objective-C

typedef void (^SMIFullQueryCompletion)(
    NSArray<id<SMIConversationEntry>> *_Nullable __strong,
    id<SMIConversation> _Nullable __strong, NSError *_Nullable __strong)

Swift

typealias FullQueryCompletion = ([Any]?, Any?, Error?) -> Void

Parameters

`messages`	Array of `SMITextMessage` results, sorted by timestamp from newest to oldest. `nil` if no results are found.
`conversation`	`SMIConversation` object associated with all returned entries.
`error`	If the query results in an error, it is returned here. An empty result is not considered an error.


                    
                    
                    SMISingleConversationQueryCompletion

Completion block for returning all conversations stored in the database.

Declaration

Objective-C

typedef void (^SMISingleConversationQueryCompletion)(
    id<SMIConversation> _Nullable __strong, NSError *_Nullable __strong)

Swift

typealias SingleConversationQueryCompletion = (Any?, Error?) -> Void

Parameters

`conversation`	The `SMIConversation` objects, based on the given UUID.
`error`	If the query results in an error, it is returned here. An empty result is not considered an error.


                    
                    
                    SMIConversationQueryCompletion

Completion block for returning all conversations stored in the database.

Declaration

Objective-C

typedef void (^SMIConversationQueryCompletion)(
    NSArray<id<SMIConversation>> *_Nullable __strong,
    NSError *_Nullable __strong)

Swift

typealias ConversationQueryCompletion = ([Any]?, Error?) -> Void

Parameters

`conversations`	Array of conversation `SMIConversation` objects. Unsorted.
`error`	If the query results in an error, it is returned here. An empty result is not considered an error.


                    
                    
                    SMIRemoteConfigurationCompletion

Completion block for returning all conversations stored in the database.

Declaration

Objective-C

typedef void (^SMIRemoteConfigurationCompletion)(
    id<SMIRemoteConfiguration> _Nullable __strong, NSError *_Nullable __strong)

Swift

typealias RemoteConfigurationCompletion = (RemoteConfiguration?, Error?) -> Void

Parameters

`remoteConfiguration`	The remote configuration matching your configured embedded service deployment.
`error`	If the query results in an error, it is returned here. An empty result is not considered an error.


                    
                    
                    SMIRoutingTypes

An enum which describes a set of routing types Possible values:

Declaration

Objective-C

typedef NSString *SMIRoutingTypes

Swift

struct RoutingTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIRoutingWorkTypes

An enum which describes a set of routing work result workTypes Possible values:

Declaration

Objective-C

typedef NSString *SMIRoutingWorkTypes

Swift

struct RoutingWorkTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMITemplatedUrlParametersCompletion

Completion block for a templated URL used by the auto-response messaging component.

Declaration

Objective-C

typedef void (^SMITemplatedUrlParametersCompletion)(
    __strong id<SMITemplateable>)

Swift

typealias URLParameterValueCompletion = (SMITemplateable?) -> Void


                    
                    
                    SMITypingIndicatorTypes

An enum which describes a set of typing indicator types Possible values:

Declaration

Objective-C

typedef NSString *SMITypingIndicatorTypes

Swift

struct TypingIndicatorTypes : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable


                    
                    
                    SMIUserVerificationChallengeCompletion

Completion block for user verification..

Declaration

Objective-C

typedef void (^SMIUserVerificationChallengeCompletion)(
    SMIUserVerification *_Nullable __strong)

Swift

typealias UserVerificationChallengeCompletion = (UserVerification?) -> Void

Parameters


                                userVerification

The SMIUserVerification object which contains the customer identity token used to verify the user identity.