Enumerations
- IMI.ICInteractiveDataType
- IMI.ICTemplateType
- IMI.ICFormFieldType
- IMI.ICContentType
- IMI.ICMessageStatus
- IMI.ICErrorCodes
- IMI.ICAccessLevel
- IMI.ICAccessLevelFilter
- IMI.ICConnectionStatus
- IMI.ICDeviceProfileParam
- IMI.ICMessageType
IMI.ICInteractiveDataType
This enumeration describes the Interactive data type for message.
| Value | Description |
|---|---|
| FormResponse | Form response is for message type ‘form’ |
| WebURL | Data is of type web URL |
| TemplatePostback | Data is of type Template Postback |
| QuickReplyPostback | Data is of type Quick Reply Postback |
IMI.ICTemplateType
This enumeration describes the type of templates supported for message.
| Value | Description |
|---|---|
| Form | Indicates the form message which will accept a set of form fields |
| Generic | Indicates the templates for display and input |
IMI.ICFormFieldType
This enumeration describes the type of form fields supported for message type “form”
Validation should be a part of UI as per application requirements
| Value | Description |
|---|---|
| Text | Text This field is string input |
| Name | This field is string input |
| This field is string input | |
| Integer | This field is integer input |
| Decimal | This field is decimal input |
| Date | This field is integer input |
| Dropdown | This field is a dropdown input |
| MultiSelectDropdown | This field allows multiple value selection |
IMI.ICContentType
| Value | Description |
|---|---|
| Audio | Media type is Audio |
| File | Media type is file |
| Video | Media type is Video |
| Image | Media type is Image |
| Url | Media type is a URL link |
| Template | Media type is a Form Template |
IMI.ICMessageStatus
This enumeration describes the status of message
| Value | Description |
|---|---|
| None | Status not available |
| NotSent | Message has not been sent |
| Sent | Message has been sent |
| Delivered | Message has been delivered |
| Read | Message has been read |
| Clicked | Message has been clicked |
IMI.ICErrorCodes
This enumeration describes different error codes of the SDK.
| Value | Description |
|---|---|
| Not Initialized | Returned when trying to access a feature without initializing the SDK. |
| AlreadyInitialized | Returned when trying to initialize the SDK when it is already initialized. |
| ConnectionAlreadyExists | Returned when the connection is already established. |
| NotRegistered | Returned when trying to access a feature without registering a user. |
| FeatureNotSupported | Returned when trying to access a feature that is not supported by the app. |
| InvalidParameterValue | Returned when a required parameter is not passed or an invalid value has been passed to a method. |
| PermissionNotGranted | Returned when access is not granted to a permission that is required for operation. |
| NotConnected | Returned when trying to communicate with the Live Chat / In-App Messaging server without establishing a connection. |
| ConnectionFailure | Returned when a connection is failed between the SDK and Live Chat / In-App Messaging server. |
| PublishFailed | - Returned when a publication of an Live Chat / In-App Messaging message has failed. - Publishing typing indicator rate limited, please try again later. - Publishing typing indicator is already in progress. |
| SubscribeFailed | Returned when a subscription to an Live Chat / In-App Messaging topic has failed. |
| UnsubscribeFailed | Returned when trying to unsubscribe from an Live Chat / In-App Messaging topic has failed. |
| Unknown | Returned when an unknown error occurs. |
| DeviceIdCurrentlyNotRegistered (code 6006) | Returned when the device ID is currently not registered. |
| DuplicateRegisterListener (code 6026) | Duplicate register listener. |
| InvalidToken (code 6027) | Invalid token. |
| InvalidAuthorizationRequest (code 6028) | Invalid authorization request. |
| TokenExpired (code 6029) | Token has expired. |
| TokenRequired (code 6030) | Token is required. |
| AlreadyProcessing | Returned when SDK is already processing a registration or unregistration request. |
| InvalidContentType | Invalid content type |
| InternalError | Returned in case file upload failure |
| DeviceIdAlreadyRegistered | Returned when a device is already registered for push. |
| SDKVersionNotSupported | Indicates the SDK version not supported |
IMI.ICAccessLevel
This enumeration describes different access levels a topic can have. Write access is required to publish to a topic. Read access is required to subscribe to a topic.
| Value | Description |
|---|---|
| Read | Users are only permitted to receive a message on the topic. |
| Write | Users are allowed to publish a message on the topic. |
| ReadWrite | Users can receive and publish messages on the topic. |
IMI.ICAccessLevelFilter
This enumeration describes different filters used to fetch topics.
| Value | Description |
|---|---|
| All | Used to fetch all the topics regardless of access level. |
| Read | Used to fetch the topics with Read access. |
| Write | Used to fetch the topics with Write access. |
| ReadWrite | Used to fetch the topics with ReadWrite access. |
IMI.ICConnectionStatus
This enumeration describes different connection statuses between the SDK and the Real-Time Messaging server.
| Value | Description |
|---|---|
| None | No connection attempt has been made. |
| Connecting | The SDK is attempting to establish a connection to the Real-Time Messaging server. |
| Connected | The SDK is connected and allows you to publish and receive messages. |
| Refused | The connection is refused by the server. Note: Currently this value is not used. |
| Closed | The SDK is disconnected from the Real-Time Messaging server. |
| Error | A connection error has occurred. |
IMI.ICDeviceProfileParam
This enumeration describes different connection statuses and their respective error codes.
| Value | Description |
|---|---|
| UserId | Specifies the value passed in the UserId parameter in DeviceProfileParam. |
| CustomerId | Specifies the value passed in the CustomerId parameter in DeviceProfileParam. |
IMI.ICMessageType
This enumeration describes the different types of messages.
| Value | Description |
|---|---|
| Message | The message is a standard Live Chat / In-App Messaging. |
| ReadReceipt | The message data is ReadReceipt. Only TransactionId is available and can be used to match receipt to the original message. |
| Republish | The message is a republish of a MO, all data available in the original message is available. |
| ClickedReceipt | Message is a clicked receipt |
| Message Delivered | |
| Message Deleted | |
| MessageNotification | The message is a notification. |
| UpdateThread | |
| ReopenThread | |
| CloseThread | |
| TypingStart | |
| TypingStop | |
| Alert | Indicates an Alert style message |
Updated about 2 months ago
