Enumerations

This version of the SDK added one more Enum class as ICEnvironment.

ICConnectionStatus

This enumeration describes the various statuses for the connection between the SDK and the In-App Message broker.

ValueDescription
NoneNo connection attempt has been made.
ConnectingA connection attempt is in progress.
ConnectedA connection has been established.
RefusedThe connection was refused by the broker.
Note: Not currently used.
DisconnectingA disconnection attempt is currently in progress.
ClosedThe connection has been closed.
ErrorA connection error has occurred.

ICDeviceProfileParam

This enumeration describes the different device profile parameters supported for update and remove operations.

ValueDescription
UserIdRepresents the User Id attribute of the device profile.
CustomerIdRepresents the Customer Id attribute of the device profile.

ICErrorCode

This enumeration describes the various error codes exposed by the SDK.

ValueDescription
Not InitializedIndicates the SDK has not been initialized/started.
AlreadyInitializedIndicates the SDK is already started, but another attempt has been made.
NotRegisteredIndicates attempted access to a feature before registering a user.
FeatureNotSupportedIndicates attempted access to a feature that is not enabled within the Webex Connect app configuration.
InvalidParameterValueIt indicates that a required parameter is missing or an invalid value has been passed.
PermissionNotGrantedIndicates that permission required to process operation has not been granted.
AlreadyRegisteredIndicates a user is already registered but another registration attempt has been made.
PushRegistrationFailedIndicates that the SDK failed to register for push notifications.
RestFailureIt indicates that a REST API call to the Webex Connect platform has failed. Used exclusively with ICRestException that exposes the underlying error.
NotConnectedIndicates an In-App Messaging operation has been attempted while no active connection exists.
ConnectionFailureIndicates that an In-App Messaging connection error occurred.
PublishFailedIndicates that the In-App Message publication failed.
SubscribeFailedIndicates that the topic subscription operation failed.
UnsubscribeFailedIndicates that the operation to unsubscribe from a topic failed.
GeneratePinTimeoutIt indicates that the Pin generation process has timed out during the listening phase.
TokenInvalidIndicates the Security Token is invalid.
TokenRequiredIt indicates that a Security Token is required.
TokenExpiredIt indicates that a Security Token has expired.
UnknownIndicates that an unknown error has occurred.

ICLogTarget

This enumeration describes the targets that may be used with the logging system.

ValueDescription
FileLogs will be displayed in the console.
ConsoleLogs will be recorded in a file.

ICLogType

This enumeration describes the type of logging that the SDK will produce.

ValueDescription
NoneNo logging information will be generated.
DebugLogging information suitable for debugging in a development environment will be generated.
ProductionMinimal logging information, suitable for production environments, will be generated.

ICMessageChannel

This enumeration describes the supported message channels.

ValueDescription
PushChannel for Push messages.
AppMessagingChannel for In-App messages.

ICMessageStatus

This enumeration describes the various message statuses.

ValueDescription
NoneIt indicates that the message has been created but no send attempt has been made.
SentIt indicates that the message was successfully sent to the Webex Connect platform.
NotSentIt indicates that sending of the message to the Webex Connect platform failed.
DeliveredIt indicates that the message has been delivered.
ReadIt indicates that the message has been read.
ClickedA message clicked by user

ICMessageSynchronizationMode

This enumeration describes the various message synchronization modes.

ValueDescription
NoneSynchronization is disabled.
LimitedSynchronization is constrained by limits.
FullSynchronization of all message data.

ICMessageType

This enumeration describes the different types of messages.

ValueDescription
AlertIndicates an Alert style message.
DeliveryReceiptIndicates the message is a delivery receipt for another standard message.
MessageIndicates the message is a standard Push or In-App message.
MessageNotificationIndicates the message is a Push notification that is coupled to a standard In-App message.
ReadReceiptIndicates the message is a read-receipt for another standard message.
RepublishIt indicates that the message is a republish of another standard message. This type is used to help support the synchronization of user originated messages to other devices.
ThreadUpdateIndicates that the message contains updated thread data. This type is used to synchronize changes of thread data to user devices.
TypingStartThe message is an indicator that typing has started.
TypingStopThe message is an indicator that typing has stopped.
ClickedReceiptMessage Data is a clicked event of template element button.

ICThreadStatus

This enumeration describes the various thread statuses used by the SDK.

ValueDescription
ActiveIt indicates that the thread is considered as active.
ClosedIndicates that the thread is considered as closed.

ICThreadType

This enumeration describes the types of threads used by the SDK.

ValueDescription
AnnouncementIndicates a read-only thread that may be used for one-way announcements. It is not possible to publish messages to this type of thread from the SDK.
ConversationIndicates a thread which may be used for bi-directional communication.

ICEnvironment

This enumeration describes the Webex Connect server environment used by the SDK.

Parameters:

ValueDescription
UKUnited Kingdom server
USUnited States server
TCTelecity server
INIndia server
CACanada server
AZURE_USUnited States server for azure

ICInteractiveDataType

This enumeration describes the Interactive data type for message.

Parameters:

ValueDescription
FormResponseForm response for message type “form”
WebUrlGeneric template element’s button click action which opens WebURL.
TemplatePostbackGeneric Template element’s button click action which sends click event.
QuickReplyPostbackQuick Reply Button click action.

ICTemplateType

This enumeration describes the type of templates supported for message.

Parameters:

ValueDescription
FormIndicates the form message which will accept a set of form fields
GenericIndicates the generic template with elements and each element has images and interactive buttons.

ICFormFieldType

This enumeration describes the type of form fields supported for message type “form”

Parameters:

ValueDescription
DateIndicates the Date type of form field
DecimalIndicates the Decimal type of form field
DropdownIndicates the Dropdown type of form field
EmailIndicates the Email type of form field
IntegerIndicates the Integer type of form field
NameIndicates the Name type of form field
TextIndicates the Text type of form field
MultiSelectDropdownIndicates the Multi select dropdown type of form field