Constants Reference
Constants
The following constants are available globally.
-
There was some form of error when sending an
SMIConversationEntryobject.Declaration
Objective-C
extern const SMIConversationEntryStatus _Nonnull SMIConversationEntryStatusErrorSwift
static let error: ConversationEntryStatus -
The initial state of an
SMIConversationEntrywhen created.Declaration
Objective-C
extern const SMIConversationEntryStatus _Nonnull SMIConversationEntryStatusSendingSwift
static let sending: ConversationEntryStatus -
The
SMIConversationEntryhas been confirmed to have been received by the messaging service.Declaration
Objective-C
extern const SMIConversationEntryStatus _Nonnull SMIConversationEntryStatusSentSwift
static let sent: ConversationEntryStatus -
The
SMIConversationEntryis confirmed to have been delivered to the other participant’s client.Declaration
Objective-C
extern const SMIConversationEntryStatus _Nonnull SMIConversationEntryStatusDeliveredSwift
static let delivered: ConversationEntryStatus -
The
SMIConversationEntryis confirmed to have been read by the other participant.Declaration
Objective-C
extern const SMIConversationEntryStatus _Nonnull SMIConversationEntryStatusReadSwift
static let read: ConversationEntryStatus -
Deprecated
The
SMIConversationEntryhas failed when sent to a botDeclaration
Objective-C
extern __deprecated_enum_msg("Use `SMIConversationEntryStatusError`") const SMIConversationEntryStatus SMIConversationEntryStatusAttachmentErrorSwift
static let attachmentError: ConversationEntryStatus -
Describes a Typing type.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesTypingIndicatorSwift
static let typingIndicator: ConversationEntryTypes -
Describes a Message type.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesMessageSwift
static let message: ConversationEntryTypes -
Describes a Choice type.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesChoiceSwift
static let choice: ConversationEntryTypes -
Describes a Selection type.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesSelectionSwift
static let selection: ConversationEntryTypes -
Describes a Participant Changed type.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesParticipantChangedSwift
static let participantChanged: ConversationEntryTypes -
Describes a Read Ack.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesReadAckSwift
static let readAck: ConversationEntryTypes -
Describes a Delivery Ack.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesDeliveryAckSwift
static let deliveryAck: ConversationEntryTypes -
Describes a RichMessage.
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesRichMessageSwift
static let richMessage: ConversationEntryTypes -
Describes a RoutingWorkResult
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesRoutingWorkResultSwift
static let routingWorkResult: ConversationEntryTypes -
Describes a RoutingResult
Declaration
Objective-C
extern const SMIConversationEntryTypes _Nonnull SMIConversationEntryTypesRoutingResultSwift
static let routingResult: ConversationEntryTypes -
Describes a Text Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesTextMessageSwift
static let textMessage: ConversationFormatTypes -
Describes an Image Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesImageMessageSwift
static let imageMessage: ConversationFormatTypes -
Describes a Rich Link Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesRichLinkSwift
static let richLink: ConversationFormatTypes -
Describes a ListPicker Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesListPickerSwift
static let listPicker: ConversationFormatTypes -
Describes a QuickReply Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesQuickRepliesSwift
static let quickReplies: ConversationFormatTypes -
Describes a Selections Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesSelectionsSwift
static let selections: ConversationFormatTypes -
Describes a Attachement Message format.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesAttachmentsSwift
static let attachments: ConversationFormatTypes -
Describes an webview formated message.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesWebViewSwift
static let webView: ConversationFormatTypes -
This format is unknown or unspecified. This applies to certain ephemeral events.
Declaration
Objective-C
extern const SMIConversationFormatTypes _Nonnull SMIConversationFormatTypesUnspecifiedSwift
static let unspecified: ConversationFormatTypes -
Network related errors.
Declaration
Objective-C
extern const NSErrorDomain SMIErrorNetworkDomainSwift
let SMIErrorNetworkDomain: String -
UserVerification related errors.
Declaration
Objective-C
extern const NSErrorDomain SMIErrorUserVerificationDomainSwift
let SMIErrorUserVerificationDomain: String -
A network response code error.
Declaration
Objective-C
extern NS_SWIFT_NAME(errorNetworkHTTPResponseCode) const NSErrorUserInfoKey SMIErrorNetworkHTTPResponseCodeSwift
let errorNetworkHTTPResponseCode: String -
A network response body error.
Declaration
Objective-C
extern NS_SWIFT_NAME(errorNetworkHTTPResponseBody) const NSErrorUserInfoKey SMIErrorNetworkHTTPResponseBodySwift
let errorNetworkHTTPResponseBody: String -
A network file size limit error.
Declaration
Objective-C
extern NS_SWIFT_NAME(errorNetworkHTTPFileSizeLimit) const NSErrorUserInfoKey SMIErrorNetworkHTTPFileSizeLimitSwift
let errorNetworkHTTPFileSizeLimit: String -
Describes a successful routing.
Declaration
Objective-C
extern const SMIFailureTypes _Nonnull SMIFailureTypesNoneSwift
static let none: FailureTypes -
Describes an unknown error.
Declaration
Objective-C
extern const SMIFailureTypes _Nonnull SMIFailureTypesUnknownSwift
static let unknown: FailureTypes -
Describes an error that has a submission failure.
Declaration
Objective-C
extern const SMIFailureTypes _Nonnull SMIFailureTypesSubmissionErrorSwift
static let submissionError: FailureTypes -
Describes an error that has a routing failure.
Declaration
Objective-C
extern const SMIFailureTypes _Nonnull SMIFailureTypesRoutingErrorSwift
static let routingError: FailureTypes -
Describes an error from canceled routing.
Declaration
Objective-C
extern const SMIFailureTypes _Nonnull SMIFailureTypesCancelledSwift
static let cancelled: FailureTypes -
Logging message associated with network operations.
Declaration
Objective-C
extern const SMILoggingCategory _Nonnull SMILoggingCategoryNetworkingSwift
static let networking: LoggingCategory -
Logging message associated with non-network activity.
Declaration
Objective-C
extern const SMILoggingCategory _Nonnull SMILoggingCategoryAPISwift
static let API: LoggingCategory -
Describes a messaging reason set to Automated Response.
Declaration
Objective-C
extern const SMIMessageReason _Nonnull SMIMessageReasonAutomatedResponseSwift
static let automatedResponse: MessageReason -
Describes a messaging reason set to None.
Declaration
Objective-C
extern const SMIMessageReason _Nonnull SMIMessageReasonNoneSwift
static let none: MessageReason -
Unable to connect to the network.
Declaration
Objective-C
extern const SMINetworkConnectivityState _Nonnull SMINetworkConnectivityStateOfflineSwift
static let offline: NetworkConnectivityState -
We have an active connection to the network.
Declaration
Objective-C
extern const SMINetworkConnectivityState _Nonnull SMINetworkConnectivityStateConnectedSwift
static let connected: NetworkConnectivityState -
Plain text MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesTextPlainSwift
static let textPlain: NetworkMimeTypes -
Event stream MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesTextEventStreamSwift
static let textEventStream: NetworkMimeTypes -
JSON MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesApplicationJSONSwift
static let applicationJSON: NetworkMimeTypes -
Octet stream MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesApplicationOctetStreamSwift
static let applicationOctetStream: NetworkMimeTypes -
PNG image MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesImagePNGSwift
static let imagePNG: NetworkMimeTypes -
JPEG image MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesImageJPEGSwift
static let imageJPEG: NetworkMimeTypes -
BMP image MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesImageBMPSwift
static let imageBMP: NetworkMimeTypes -
GIF image MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesImageGIFSwift
static let imageGIF: NetworkMimeTypes -
TIFF image MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesImageTIFFSwift
static let imageTIFF: NetworkMimeTypes -
Multi-part form MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesMultiPartFormSwift
static let multiPartForm: NetworkMimeTypes -
GZIP MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesGZIPSwift
static let GZIP: NetworkMimeTypes -
PDF MIME type.
Declaration
Objective-C
extern SMINetworkMimeTypes SMINetworkMimeTypesApplicationPDFSwift
static let applicationPDF: NetworkMimeTypes -
Describes an operation for adding a participant to a conversation.
Declaration
Objective-C
extern const SMIParticipantChangedOperationTypes _Nonnull SMIParticipantChangedOperationTypesAddSwift
static let add: ParticipantChangedOperationTypes -
Describes an operation for removing a participant from a conversation.
Declaration
Objective-C
extern const SMIParticipantChangedOperationTypes _Nonnull SMIParticipantChangedOperationTypesRemoveSwift
static let remove: ParticipantChangedOperationTypes -
Participant system role.
Declaration
Objective-C
extern SMIParticipantRole SMIParticipantRoleSystemSwift
static let system: ParticipantRole -
Participant user role.
Declaration
Objective-C
extern SMIParticipantRole SMIParticipantRoleUserSwift
static let user: ParticipantRole -
Participant agent role.
Declaration
Objective-C
extern SMIParticipantRole SMIParticipantRoleAgentSwift
static let agent: ParticipantRole -
Participant chatbot role.
Declaration
Objective-C
extern SMIParticipantRole SMIParticipantRoleChatbotSwift
static let chatbot: ParticipantRole -
Participant supervisor role.
Declaration
Objective-C
extern SMIParticipantRole SMIParticipantRoleSupervisorSwift
static let supervisor: ParticipantRole -
A pre-chat form type.
Declaration
Objective-C
extern const SMIPreChatConfigurationFormTypes _Nonnull SMIPreChatConfigurationFormTypePreChatSwift
static let typePreChat: SMIPreChatConfigurationFormTypes -
A text pre-chat field.
Declaration
Objective-C
extern const SMIPreChatFieldTypes _Nonnull SMIPreChatFieldTypesTextSwift
static let text: PreChatFieldTypes -
A text area pre-chat field.
Declaration
Objective-C
extern const SMIPreChatFieldTypes _Nonnull SMIPreChatFieldTypesTextAreaSwift
static let textArea: PreChatFieldTypes -
An email pre-chat field.
Declaration
Objective-C
extern const SMIPreChatFieldTypes _Nonnull SMIPreChatFieldTypesEmailSwift
static let email: PreChatFieldTypes -
A number pre-chat field.
Declaration
Objective-C
extern const SMIPreChatFieldTypes _Nonnull SMIPreChatFieldTypesNumberSwift
static let number: PreChatFieldTypes -
A phone pre-chat field.
Declaration
Objective-C
extern const SMIPreChatFieldTypes _Nonnull SMIPreChatFieldTypesPhoneSwift
static let phone: PreChatFieldTypes -
A checkbox pre-chat field.
Declaration
Objective-C
extern const SMIPreChatFieldTypes _Nonnull SMIPreChatFieldTypesCheckboxSwift
static let checkbox: PreChatFieldTypes -
Describes an operation explaining a routing action has been initialized.
Declaration
Objective-C
extern const SMIRoutingTypes _Nonnull SMIRoutingTypesInitialSwift
static let initial: RoutingTypes -
Describes an operation explaining a routing action has been transfered.
Declaration
Objective-C
extern const SMIRoutingTypes _Nonnull SMIRoutingTypesTransferSwift
static let transfer: RoutingTypes -
Describes an operation for assigning a routing work result from an agent routing.
Declaration
Objective-C
extern const SMIRoutingWorkTypes _Nonnull SMIRoutingWorkTypesAssignedSwift
static let assigned: RoutingWorkTypes -
Describes an operation for accepted a routing work result from an agent routing.
Declaration
Objective-C
extern const SMIRoutingWorkTypes _Nonnull SMIRoutingWorkTypesAcceptedSwift
static let accepted: RoutingWorkTypes -
Describes an operation for closing a routing work result from an agent routing.
Declaration
Objective-C
extern const SMIRoutingWorkTypes _Nonnull SMIRoutingWorkTypesClosedSwift
static let closed: RoutingWorkTypes -
Describes a typing started event.
Declaration
Objective-C
extern const SMITypingIndicatorTypes _Nonnull SMITypingIndicatorTypesStartedSwift
static let started: TypingIndicatorTypes -
Describes a typing stopped event.
Declaration
Objective-C
extern const SMITypingIndicatorTypes _Nonnull SMITypingIndicatorTypesStoppedSwift
static let stopped: TypingIndicatorTypes