Type Definitions Reference


                    
                    
                    SMIBusinessHoursInfoCompletion

Completion block for returning the business hours of a deployment.

Declaration

Objective-C

typedef void (^SMIBusinessHoursInfoCompletion)(
    id<SMIBusinessHoursInfo> _Nullable __strong, NSError *_Nullable __strong)

Swift

typealias BusinessHoursInfoCompletion = ((any BusinessHoursInfo)?, (any Error)?) -> Void

Parameters

`businessHoursInfo`	The business hours set for a deployment.
`error`	If the query results in an error, it is returned here. An empty result is not considered an error.


                    
                    
                    SMIConversationEntryMessageTypes

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

Declaration

Objective-C

typedef NSString *SMIConversationEntryMessageTypes

Swift

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


                    
                    
                    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


                    
                    
                    SMITranscriptRequestCompletion

The completion block for returning a conversation transcript.

Declaration

Objective-C

typedef void (^SMITranscriptRequestCompletion)(PDFDocument *_Nullable __strong,
                                               NSError *_Nullable __strong)

Swift

typealias TranscriptRequestCompletion = (PDFDocument?, (any Error)?) -> Void

Parameters

`conversationTranscript`	A PDF document containing a transcript of the conversation.
`error`	If the conversation transcript request results in an error, it is returned here.


                    
                    
                    SMIDataOperationCompletion

Completion for data store operations.

Declaration

Objective-C

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

Swift

typealias DataOperationCompletion = ((any 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:

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)

Swift

typealias FileFetchCompletion = ((any Error)?) -> Void


                    
                    
                    SMIFormInputSectionType

An enum that describes possible SMIFormInputSectionType types. Possible values:

SMIFormInputSectionTypeingleInputSection

Declaration

Objective-C

typedef NSString *SMIFormInputSectionType

Swift

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


                    
                    
                    SMIFormInputType

An enum that describes possible SMIFormInputType types. Possible values:

Declaration

Objective-C

typedef NSString *SMIFormInputType

Swift

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


                    
                    
                    SMIFormInputValueType

An enum that defines SMIFormInputValueType form input value types. Possible values:

Declaration

Objective-C

typedef NSString *SMIFormInputValueType

Swift

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


                    
                    
                    SMIFormResponseErrorType

An enum that defines SMIFormResponseErrorType errors returned due to a failed form submission. Possible values:

Declaration

Objective-C

typedef NSString *SMIFormResponseErrorType

Swift

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


                    
                    
                    SMIFormResponseValueType

An enum that defines SMIFormResponseValueType form response types.

See

SMIFormResponseInputs

Declaration

Objective-C

typedef NSString *SMIFormResponseValueType

Swift

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


                    
                    
                    SMIFormResultType

An enum that defines SMIFormResultTypeFormRecordsResult types that can be returned from a form submission. Possible values:

Declaration

Objective-C

typedef NSString *SMIFormResultType

Swift

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


                    
                    
                    SMIFormTextInputType

An enum that defines SMIFormTextInputType text input types. Possible values:

Declaration

Objective-C

typedef NSString *SMIFormTextInputType

Swift

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


                    
                    
                    SMIFormTitleInteractionItemType

An enum that defines SMIFormTitleInteractionItemType option types of a multi-option input. Possible values:

SMIFormTitleInteractionItemTypeTitleOption

Declaration

Objective-C

typedef NSString *SMIFormTitleInteractionItemType

Swift

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


                    
                    
                    SMIFormTitleItemType

An enum that defines SMIFormTitleItemType types to decorate form fields or responses.

SMIFormTitleItemTypeTitleItem

Declaration

Objective-C

typedef NSString *SMIFormTitleItemType

Swift

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


                    
                    
                    SMIHiddenPreChatValueCompletion

Completion block for hidden pre-chat values.

Declaration

Objective-C

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

Swift

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


                    
                    
                    SMIListAPIDirections

Describes the way that the list is ordered.

Declaration

Objective-C

typedef NSString *SMIListAPIDirections

Swift

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


                    
                    
                    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 SMIConversationEntry objects.

Declaration

Objective-C

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

Swift

typealias FullQueryCompletion = ([any SMIConversationEntry]?, (any SMIConversation)?, (any Error)?) -> Void

Parameters

`messages`	Array of `SMIConversationEntry` 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.


                    
                    
                    SMISingleEntryQueryCompletion

Completion block for queries returning SMIConversationEntry object.

Declaration

Objective-C

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

Swift

typealias SingleEntryQueryCompletion = ((any SMIConversationEntry)?, (any SMIConversation)?, (any Error)?) -> Void

Parameters

`message`	`SMIConversationEntry` result, `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.


                    
                    
                    SMIParticipantQueryCompletion

Completion block for queries returning SMIParticipant objects.

Declaration

Objective-C

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

Swift

typealias ParticipantQueryCompletion = ([any SMIParticipant]?, (any SMIConversation)?, (any Error)?) -> Void

Parameters

`participants`	An unsorted array of `SMIParticipant` results `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

The 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 SMIConversation)?, (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

The 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 SMIConversation]?, (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.


                    
                    
                    SMIRealtimeConnectionState

The possible connection states for listening to realtime events.

Declaration

Objective-C

typedef NSString *SMIRealtimeConnectionState

Swift

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


                    
                    
                    SMIRemoteConfigurationCompletion

The 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 = ((any RemoteConfiguration)?, (any 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)(
    id<SMITemplateable> _Nonnull __strong)

Swift

typealias URLParameterValueCompletion = (any 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.