ICMessagingReceiver.onConnectionStatusChanged.
> π Note
>
> It throws an Exception if a user is not registered with Webex Connect or if the Live Chat / In-App Messaging feature is not enabled in the policy.
> π Note
>
> The Time-to-Live (TTL) limit is of 24 hours for In-App and Live Chat messages. Messages undelivered within this period will expire and will not be sent via MQTT or Web Sockets. To avoid loss of undelivered messages, app developers are recommended to implement '**[fetch threads](https://developers.imiconnect.io/docs/javascript-sdk-messaging#fetchthreads)**' and '**[fetch messages](https://developers.imiconnect.io/docs/javascript-sdk-messaging#fetchmessages)**' functionality to download these messages from the Server-Side Inbox.
>
> Note that, if Server-Side Inbox is disabled for your app asset, then these messages will be lost if they are not delivered to the customers device within 24 hours.
**Syntax:** `void connect()`
**Example:**
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
messaging.connect();
} catch (error) {
console.log(error)
}
```
### disconnect
This method is used to disconnect the connection between the app and the Webex Connect platform. If there is no active connection, then this method fails silently.\
When the disconnection is successful, the status events are notified through ICMessagingReceiver.onConnectionStatusChanged.
> π
>
> The *disconnect* method throws an Exception if a user is not registered with Webex Connect or Live Chat / In-App Messaging feature is not enabled in the policy.
ββ**Syntax:** `void disconnect()`
ββ**Example:**
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
messaging.disconnect();
} catch (error) {
console.log(error)
}
```
### fetchTopics
This method is used to get a list of topics that are configured with the Webex Connect app. Use the filter parameter to control the type of topics that are returned.\
Results are reported through a callback.
ββ**Syntax:** `void fetchTopics(start, callback)`
ββ**Parameters:**
| Parameter | Type | Description |
| :-------- | :------- | :--------------------------------- |
| start | integer | Specify starting index for results |
| callback | JSObject | Specifies the callback object. |
**Example:**
```javascript
var messaging = IMI.ICMessaging.getInstance();
var callback = {
onSuccess: function(ictopicslist) {
console.log("success");
//Write your logic to read topics and subscribe/unsubscribe/publish on those topics.
if (ictopicslist) {
for (var i = 0; i < ictopicslist.length; i++) {
var icTopic = ictopicslist[i];
console.log(icTopic.getName());
}
}
},
onFailure: function(errormsg) {
console.log("failed to get topics");
}
};
messaging.fetchTopics(IMI.ICAccessLevelFilter.All, callback);
```
### getConnectionStatus
This method is used to get the current connection status between the SDK and Webex Connect platform.
ββ**Syntax:** `ICConnectionStatus getConnectionStatus()`
ββ**Return Value:**\
ββReturns the current connection status between the SDK and the Webex Connect platform.
ββ**Example:**
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
var connectionStatus = messaging.getConnectionStatus();
if (connectionStatus == IMI.ICConnectionStatus.Connected) {
//write your logic here
}
} catch (error) {
console.log(error)
}
```
### getInstance
This method is used to get the ICMessaging singleton instance. The instance is created internally on demand.
ββ**Syntax:** `ICMessaging getInstance()`
ββ**Return Value:**\
ββReturns the ICMessaging singleton instance.
ββ**Example:**
```javascript
var messaging = IMI.ICMessaging.getInstance();
```
### isConnected
This method is used to verify whether the Live Chat / In-App Messaging connection is established between SDK and Webex Connect. This is a convenience method for getConnectionStatus() == ICConnectionStatus.Connected.
ββ**Syntax:** `boolean isConnected()`
ββ**Return Value:**\
ββReturns *true* if the Live Chat / In-App Messaging connection is established between SDK and Webex Connect.
ββ**Example:**
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
var isConnected = messaging.isConnected();
if (isConnected) {
//write your logic
}
} catch (error) {
console.log(error)
}
```
### publishMessage
This method is used to publish the passed ICMessage instance through Live Chat / In-App Messaging connection.\
The results of the operation are reported through a callback.
ββ**Syntax:** `void publishMessage(message, callback)`
ββ**Parameters:**
| Parameters | Type | Description |
| :--------- | :------------------------------- | :----------------------------- |
| message | [ICMessage ](#section-icmessage) | Refer to ICMessage class. |
| callback | JSObject | Specifies the callback object. |
ββ**Example:**
```javascript
var callback = {
onSuccess: function() {
console.log("message sent");
},
onFailure: function(errormsg) {
console.log("failed to send message");
}
};
var messaging = imi.ICMessaging.getInstance();
var message = new imi.ICMessage();
message.setMessage("Test message");
var thread = new imi.ICThread();
thread.setId("threadid ICMessagingReceiver.onMessageReceived method is called. When a connection status is changed ICMessagingReceiver.onConnectionStatusChanged method is called.\
The results of the operation are reported through a callback.
ββ**Syntax:** `void icMsgReceiverCallback`
ββ**Parameters:**
| Parameter | Type | Description |
| :------------------ | :------------------ | :--------------------------------------------------------------------------------------------------------------------- |
| icMessagingReceiver | ICMessagingReceiver | Refer to [ICMessagingReceiver.](https://developers.imiconnect.io/docs/javascript-sdk-messaging#imiicmessagingreceiver) |
ββ**Example:**
```javascript
//To receive connect status changes and published messages
var icMsgRecrCallback = new IMI.ICMessagingReceiver();
icMsgRecrCallback.onConnectionStatusChanged = function(statuscode) {
console.log("read the statuscode, based on the status do the operations");
if (statuscode == IMI.ICConnectionStatus.Connected) {
//Connected
} else if (statuscode == IMI.ICConnectionStatus.Error) {
//Error while connecting
}else if (statuscode == IMI.ICConnectionStatus.Refused) {
//Connection lost
} else {
//unknow error
}
};
icMsgRecrCallback.onMessageReceived = function(icMessage) {
//icMessage is IMI.ICMessage object
if (icMessage.getType() === imi.ICMessageType.Message) {
//here direct message came from server(message sent from api)
} else if (icMessage.getType() === IMI.ICMessageType.ReadReceipt) {
//here read receipt came from another application for device syncing(read sent from another device)
} else if (icMessage.getType() === IMI.ICMessageType.Republish) {
//here repulished message came from another application for device syncing (message send from another device)
}
}
var messaging = IMI.ICMessaging.getInstance();
messaging.setICMessagingReceiver();
```
### subscribeTopic
This method is used to subscribe to the topic that has *Read* access level, allowing the SDK to receive messages on that topic.\
The results of the operation are reported through a callback.
> π
>
> Incoming messages are received through ICMessagingReceiver.onMessageReceived.
ββ**Syntax:** `void subscribeTopic(topicId, callback)`
ββ**Parameters:**
| Parameter | Type | Description |
| :-------- | :------- | :----------------------------------- |
| topicId | String | Specifies the topic Id to subscribe. |
| callback | JSObject | Specifies the callback. |
ββ**Example:**
```javascript
//To subscribe to a topic
try {
var messaging = IMI.ICMessaging.getInstance();
var callback = {
onSuccess: function() {
console.log("success");
},
onFailure: function(errormsg) {
console.log("failed ");
}
};
var topic = "setICMessagingReceiver to set ICMessagingReceiver callback.
[block:html]
{
"html": "\n\n\n\n\n\n\n\n| Public Methods | \n \n|
|---|---|
| void | \nonConnectionStatusChanged(status) | \n
| void | \nonMessageReceived(message) | \n
| Public Methods | \n \n|
|---|---|
| String | \ngetContentType() | \n
| long | \ngetDuration() | \n
| double | \ngetLatitude() | \n
| double | \ngetLongitude() | \n
| String | \ngetPreview() | \n
| long | \ngetSize() | \n
| String | \ngetURL() | \n
| void | \nsetContentType(icContentType) | \n
| void | \nsetDuration(duration) | \n
| void | \nsetLatitude(latitude) | \n
| void | \nsetLongitude(longitude) | \n
| void | \nsetPreview(preview) | \n
| void | \nsetSize(size) | \n
| void | \nsetURL(url) | \n
| Public Methods | \n \n|
|---|---|
| String | \ngetContentType() | \n
| long | \ngetDuration() | \n
| double | \ngetLatitude() | \n
| double | \ngetLongitude() | \n
| String | \ngetPreview() | \n
| long | \ngetSize() | \n
| String | \ngetURL() | \n
| void | \nsetContentType(contentType) | \n
| void | \nsetDuration(duration) | \n
| void | \nsetLatitude(latitude) | \n
| void | \nsetLongitude(longitude) | \n
| void | \nsetPreview(preview) | \n
| void | \nsetSize(size) | \n
| void | \nsetURL(url) | \n
ICMessagingReceiver.onConnectionStatusChanged.
> π
>
> It throws an Exception if a user is not registered with Webex Connect or if the RTM feature is not enabled in the policy.
**Syntax:** `connect()`
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
messaging.connect();
} catch (error) {
console.log(error)
}
```
## disconnect
This method is used to disconnect the connection between the app and the Webex Connect platform. If there is no active connection, then this method fails silently.\
When the disconnection is successful, the status events are notified through ICMessagingReceiver.onConnectionStatusChanged.
> π
>
> The *disconnect* method throws an Exception if a user is not registered with Webex Connect or RTM feature is not enabled in the policy.
**Syntax:** `disconnect()`
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
messaging.disconnect();
} catch (error) {
console.log(error)
}
```
## fetchTopics
This method is used to get a list of topics that are configured with the Webex Connect app. Use the filter parameter to control the type of topics that are returned.
Results are reported through a callback.
**Syntax:** `fetchTopics(start, callback)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :------- | :---------------------------------- |
| start | Integer | Refer to ICAccessLevelFilter class. |
| callback | JSObject | Specifies the callback object. |
```javascript
var messaging = IMI.ICMessaging.getInstance();
var callback = {
onSuccess: function(ictopicslist) {
console.log("success");
//Write your logic to read topics and subscribe/unsubscribe/publish on those topics.
if (ictopicslist) {
for (var i = 0; i < ictopicslist.length; i++) {
var icTopic = ictopicslist[i];
console.log(icTopic.getName());
}
}
},
onFailure: function(errormsg) {
console.log("failed to get topics");
}
};
messaging.fetchTopics(start, callback);
```
## getConnectionStatus
This method is used to get the current connection status between the SDK and Webex Connect platform.
**Syntax:** `ICConnectionStatus getConnectionStatus()`
**Return Value:** Returns the current connection status between the SDK and the Webex Connect platform.
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
var connectionStatus = messaging.getConnectionStatus();
if (connectionStatus == IMI.ICConnectionStatus.Connected) {
//write your logic here
}
} catch (error) {
console.log(error)
}
```
## getInstance
This method is used to get the ICMessaging singleton instance. The instance is created internally on demand.
**Syntax:** `ICMessaging getInstance()`
**Return Value:** Returns the ICMessaging singleton instance.
```javascript
var messaging = IMI.ICMessaging.getInstance();
```
## isConnected
This method is used to verify whether the RTM connection is established between SDK and Webex Connect. This is a convenience method for getConnectionStatus() == ICConnectionStatus.Connected.
**Syntax:** `boolean isConnected()`
**Return Value:** Returns *true* if the RTM connection is established between SDK and Webex Connect.
```javascript
var messaging = IMI.ICMessaging.getInstance();
try {
var isConnected = messaging.isConnected();
if (isConnected) {
//write your logic
}
} catch (error) {
console.log(error)
}
```
## publishMessage
This method is used to publish the passed ICMessage instance through Live Chat / In-App Messaging connection.\
The results of the operation are reported through a callback.
**Syntax:** `publishMessage(message, callback)`
**Parameters:**
| Parameters | Type | Description |
| :--------- | :------------------------------- | :----------------------------- |
| message | [ICMessage ](#section-icmessage) | Refer to ICMessage class. |
| callback | JSObject | Specifies the callback object. |
```javascript
var callback = {
onSuccess: function() {
console.log("message sent");
},
onFailure: function(errormsg) {
console.log("failed to send message");
}
};
var messaging = IMI.ICMessaging.getInstance();
var message = new IMI.ICMessage();
message.setMessage("Test message");
var thread = new IMI.ICThread();
thread.setId("threadid ICMessagingReceiver.onMessageReceived method is called. When a connection status is changed ICMessagingReceiver.onConnectionStatusChanged method is called.\
The results of the operation are reported through a callback.
**Syntax:** `setICMessagingReceiver(callback)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :------------------ | :---------------------------- |
| callback | ICMessagingReceiver | Refer to ICMessagingReceiver. |
```javascript
//To receive connect status changes and published messages
var icMsgRecrCallback = new IMI.ICMessagingReceiver();
icMsgRecrCallback.onConnectionStatusChanged = function(statuscode) {
console.log("read the statuscode, based on the status do the operations");
if (statuscode == IMI.ICConnectionStatus.Connected) {
//Connected
} else if (statuscode == IMI.ICConnectionStatus.Error) {
//Error while connecting
}else if (statuscode == IMI.ICConnectionStatus.Refused) {
//Connection lost
} else {
//unknow error
}
};
icMsgRecrCallback.onMessageReceived = function(icMessage) {
//icMessage is IMI.ICMessage object
if (icMessage.getType() === IMI.ICMessageType.Message) {
//here direct message came from server(message sent from api)
} else if (icMessage.getType() === IMI.ICMessageType.ReadReceipt) {
//here read receipt came from another application for device syncing(read sent from another device)
} else if (icMessage.getType() === IMI.ICMessageType.Republish) {
//here repulished message came from another application for device syncing (message send from another device)
}
}
var messaging = IMI.ICMessaging.getInstance();
messaging.setICMessagingReceiver(icMsgRecrCallback);
```
## subscribeTopic
This method is used to subscribe to the topic that has *Read* access level, allowing the SDK to receive messages on that topic.\
The results of the operation are reported through a callback.
> π
>
> Incoming messages are received through ICMessagingReceiver.onMessageReceived.
**Syntax:** `subscribeTopic(topic, callback)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :------- | :------------------------------------- |
| topic | string | Specifies the topic name to subscribe. |
| callback | JSObject | Specifies the callback. |
```javascript
//To subscribe to a topic
try {
var messaging = IMI.ICMessaging.getInstance();
var callback = {
onSuccess: function() {
console.log("success");
},
onFailure: function(errormsg) {
console.log("failed ");
}
};
var topic = "streamId and threadTitle and send the result in a callback.
**Syntax:** `createThread(streamId, threadtitle, createThreadCallBack)`
**Parameters:**
| Parameter | Type | Description |
| :---------- | :----- | :---------------------------------------------- |
| streamId | string | Identity of the stream. |
| threadTitle | string | Title of the thread. |
| callback | | Invokes to report operation success or failure. |
```javascript
var createThreadCallBack = {
onSuccess: function (thread)
{
console.log(thread);
},
onFailure: function ()
{
console.log("failed to create thread")
}
};
messaging.createThread(steamid, threadtitle, createThreadCallBack);
```
## fetchThreads
This method is used to get a list of threads that are created and at least one message transaction completed. Results are reported through the callback.
**Syntax:** `fetchThreads(offset, limit, callback)`
**Parameters:**
[block:parameters]
{
"data": {
"h-0": "Parameter",
"h-1": "Type",
"h-2": "Description",
"0-0": "offset",
"0-1": "string (mandatory parameter)",
"0-2": "Pass offset value to fetch threads from that offset value. \n \nDefault value is 0.",
"1-0": "limit",
"1-1": "Integrer (mandatory parameter)",
"1-2": "Specifies the maximum number of items that can be returned in threads array. \n \nDefault value is 100.",
"2-0": "callback",
"2-1": "Callback",
"2-2": "Invokes to report if operation is a success or failure. \n \nSuccess callback returns an additional value, a positive value indicating more threads on the server. \n \n`unread_msg_count`: Each thread object returns this based upon βserver_inbox_versionβ in policy. \n \n`onFetchThreadsSuccess(threads, hasMoreThreads)`"
},
"cols": 3,
"rows": 3,
"align": [
"left",
"left",
"left"
]
}
[/block]
```javascript
var messaging = IMI.ICMessaging.getInstance();
messaging.fetchThreads(offset, limit, callback);
```
## fetchThread
This method is used to retrieve a particular thread by threadId. Results are reported through the callback
**Syntax**:Β `messaging.fetchThread(threadId, Β fetchThreadCallback);`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
| threadId | string | Specify threadId to retrieve |
| callback | Callback | Callback object containing onSuccess and onFailure methods. Returns thread object if found else returns null in onSuccess. Returns onFailure otherwise. |
**Sample Code**:
```javascript
fetchThreadCallback = {
onSuccess: (thread) => {
console.log('fetchThread:onSuccess', thread);
if (thread) {
console.log(thread);
}
else
console.log("No thread found with ID: ", document.querySelector('#txtThreadIdForFetchThread').value);
},
onFailure: (error) => {
console.log('fetchThread: errormsg: ', error);
},
};
var messaging = IMI.ICMessaging.getInstance();
messaging.fetchThread(threadId, fetchThreadCallback);
```
## fetchMessages
This method is used to get a list of messages from the Webex Connect platform. All results are reported through the callback.
**Syntax:** `fetchMessages(threadId, beforeDate, limit, callback)`
**Parameters:**
[block:parameters]
{
"data": {
"h-0": "Parameter",
"h-1": "Type",
"h-2": "Description",
"0-0": "threadId",
"0-1": "string",
"0-2": "Specifies the ThreadId value.",
"1-0": "beforeDate",
"1-1": "Date",
"1-2": "Specifies the date since the messages must be returned. This value is optional; if nothing is passed then it is considered as current Date Time.",
"2-0": "limit",
"2-1": "Integer",
"2-2": "Specifies the maximum number of items that can be returned in messages array. \n \nDefault value is 100",
"3-0": "calback",
"3-1": "Callback",
"3-2": "Invokes to report if operation is a success or failure. \n \n**totalCount**: `fetchMessagesCallback` returns total number of messages for the userid/thread. \n \n`fetchMessagesSuccess(messages: any[], totalCount)`",
"4-0": "isOutgoing",
"4-1": "Boolean",
"4-2": "Indicates if the message is mobile originated if the value is true."
},
"cols": 3,
"rows": 5,
"align": [
"left",
"left",
"left"
]
}
[/block]
```javascript
var messaging = IMI.ICMessaging.getInstance();
var messagesCallBack = {
onSuccess: function (messages) {
},
onFailure: function () {
console.log("failed to get messages");
}
};
messaging.fetchMessages(threadId, beforeDate, limit, callback);
```
## fetchUnreadThreadCount
This method is used to get the count of threads that have unread messages.
**Syntax:** `fetchUnreadThreadCount(callback)`
**Parameters:**
[block:parameters]
{
"data": {
"h-0": "Parameter",
"h-1": "Type",
"h-2": "Decsription",
"0-0": "callback",
"0-1": "Callback",
"0-2": "Invokes to report if operation is a success or failure. \n \n**Count**: returns the unread thread count for user \n \n`fetchUnreadThreadCountSuccess(count)`"
},
"cols": 3,
"rows": 1,
"align": [
"left",
"left",
"left"
]
}
[/block]
```javascript
var messaging = IMI.ICMessaging.getInstance();
messaging.fetchUnreadThreadCount(callback);
```
## getSDKVersion
This method gets the SDK version being used.
**Syntax:** `getSDKVersion()`
**Returns:** string version of SDK
```javascript
this.sdkVersion = "v" + IMI.getSDKVersion();
```
## sendClickedEvent()
Use this method to send Clicked Event to Webex Connect platform
| Parameter | Description |
| :------------------- | :-------------------------------------------------------- |
| messageTransactionId | transactionId of the original message |
| icButton | The ICButton instance that triggered this call |
| callback | The callback sample code is provided in the below example |
**Sample Code**:
```javascript
var submitClickPostbackCallback = {
onSuccess: (icButton) => {
console.log(`"${icButton.getTitle()}" clicked!`);
},
onFailure: (errormsg) => {
console.log(errormsg);
},
};
messaging.sendClickedEvent(message.getTransactionId(), icButton, this.submitClickPostbackCallback
```
## createPostbackMessage()
Creates ICMessage instance for Incoming message Interactive/Quick Replies button
| Parameter | Description |
| :-------- | :--------------------------------------------- |
| icMessage | Original Message object |
| icButton | The ICButton instance that triggered this call |
**Sample Code**:
```javascript
var publishMessageCallback =
{ onSuccess: (message) => {
//do something
},
onFailure: (errormsg) => {
//do something
},
};
let postbackQuickReplyMO = IMI.ICMessaging.getInstance().createPostbackMessage(message, icButton)
messaging.publishMessage(postbackQuickReplyMO,
publishMessageCallback);
```
## IMI.ICMessagingReceiver
This class allows the interception of incoming messages and RTM connection status changes. The default class provides standard message handling. You must invoke setICMessagingReceiver to set ICMessagingReceiver callback.
| Public Methods | |
| :------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| | [onConnectionStatusChanged(status)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#onconnectionstatuschanged) |
| | [onMessageReceived(message)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#onmessagereceived) |
## onConnectionStatusChanged
This method is invoked whenever there is a change to the RTM connection status.
**Syntax:** `onConnectionStatusChanged(status)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :------------------------------------------------------------------------------------------------------------ | :--------------------------------- |
| status | [ICConnectionStatus](https://developers.imiconnect.io/docs/javascript-sdk-enumerations#imiicconnectionstatus) | Refer to ICConnectionStatus class. |
## onMessageReceived
This method is invoked whenever a new RTM message is received.
**Syntax:** `onMessageReceived(message)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :----------------------------------------------------------- | :------------------------ |
| message | [ICMessage](https://developers.imiconnect.io/docs/icmessage) | Refer to ICMessage class. |
## IMI.ICMessage
This class exposes message data from RTM and Push channels in a generalized form and is also used to send Real-Time Messages from an app to the Webex Connect platform.
**Parameters**:
| Public Methods | |
| :------------------- | :---------------------------------------------------------------------------------------------------------------------- |
| | [getAttachments()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getattachments) |
| string | [getCategory()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getcategory) |
| string | [getChannel()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getchannel) |
| JSObject | [getCustomTags()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getcustomtags) |
| | [getDeliveredAt()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getdelivered) |
| JSObject | [getExtras()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getextras) |
| IMI.ICMediaFile\[] | [getMedia()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getmedia) |
| string | [getMessage()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getmessage) |
| IMI.ICQuickReplyData | [getQuickReplyData()](#getQuickReplyData) |
| boolean | [getReadAt()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getreadat) |
| string | [getReplyTo()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getreplyto) |
| boolean | [getReadAt()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getreadat) |
| | [getRelatedTransactionId()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getrelatedtransactionid) |
| | [getInteractiveData()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getinteractivedata) |
| string | [getSenderId()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getsenderid) |
| | [getSubmittedAt()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getsubmitted) |
| | [getThread()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getthread) |
| string | [getTopic()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#gettopic) |
| string | [getTransactionId()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#gettransactionid) |
| | [getType()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#gettype) |
| string | [getUserId()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#getuserid-1) |
| | [setAttachments()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setattachments) |
| | [setCustomTags(tags)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setcustomtags) |
| | [setMedia(files)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setmedia) |
| | [setMessage(message)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setmessage) |
| | [setRelatedTransactionId()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setrelatedtransactionid) |
| | [setSenderId(senderId)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setsenderid) |
| | [setQuickReplyData(icQuickReplyData)](#setQuickReplyData\(icQuickReplyData\)) |
| string | [setTopic(topic)](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#settopic) |
| | [setThread()](https://developers.imiconnect.io/docs/javascript-sdk-api-reference#setthread) |
| string | [getTemporaryId()](#getTemporaryId\(\)) |
## getCategory
This method is used to get the category of the interactive message.
**Syntax:** `String getCategory()`
**Return Value:** Returns the category of the message.
## getChannel
This method is used to get the channel on which the message was received.
**Syntax:** `String getChannel()`
**Return Value:** Returns the channel.
## getCustomTags
This method is used to get the custom or developer specified data that was sent as part of the message payload.
**Syntax:** `JSObject getCustomTags()`
**Return Value:** Returns the custom tags sent along with the message payload.
## getExtras
This method is used to get the supplementary data that was sent as part of the message payload. The format of this data is controlled by the Webex Connect platform.
**Syntax:** `JSObject getExtras()`
**Return Value:** Returns the supplementary data that was sent along with the message payload.
## getMedia
This method is used to get the media files that are attached to the message.
**Syntax:** `IMI.ICMediaFile[] getMedia()`
**Return Value:** Returns the media files that ware attached to the message.
## getMessage
This method is used to get the content of the message that is displayed to the end-users.
**Syntax:** `String getMessage()`
**Return Value:** Returns the text message that is displayed to the end-users.
## getQuickReplyData
This method is used to return ICQuickReplyData instance that was sent as part of the message.
**Syntax:** icMessage.getQuickReplyData()
**Return Value:** IMI.ICQuickReplyData instance.
## getReplyTo
This method is used to get the topic to which the reply should be sent. This method is not applicable to Push messaging.
**Syntax:** `String getReplyTo()`
**Return Value:** Returns the topic to which reply should be sent.
## getSenderId
This method is used to get the senderId an arbitrary identifier that is set by the sender of the message. This method is not applicable to Push messaging.
**Syntax:** `String getSenderId()`
**Return Value:** Returns the senderid of the message.
## getTopic
This method is used to get the topic on which the message was received. This method is not applicable to Push messaging.
**Syntax:** `String getTopic()`
**Return Value:** Returns the topic on which the message was received.
## getTransactionId
This method is used to get the transaction id that uniquely identifies the message transaction within the Webex Connect platform.
**Syntax:** `String getTransactionId()`
**Return Value:** Returns the transaction id that identifies the message transaction.
## getUserId
This method is used to get the user id from which the message is originated. This method is not applicable to Push messaging.
**Syntax:** `String getUserId()`
**Return Value:** Returns the user id from which the message is originated.
## setCustomTags
This method is used to set the custom tags object to be sent with an outgoing RTM. This method is not applicable to Push messaging.
**Syntax:** `setCustomTags(tags)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :------- | :---------------------- |
| tags | JSObject | Specifies the JSObject. |
## setMedia
This method is used to set the media file attachments to be sent with an outgoing RTM. This method is not applicable to Push messaging.
**Syntax:** `setMedia(files)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :----------------------------------------------------------------------------------------------- | :----------------------------- |
| files | [IMI.ICMediaFile](https://developers.imiconnect.io/docs/javascript-sdk-messaging#imiicmediafile) | Refer to IMI.ICMediaFile class |
## setMessage
This method is used to set the content of the text message to be sent with an outgoing RTM. This method is not applicable to Push messaging.
**Syntax:** `setMessage(message)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :----- | :----------------------------------------- |
| message | string | Specifies the content of the text message. |
## setSenderId
This method is used to set the senderid to be sent with an outgoing RTM. This is arbitrary information such as a simple tag. This method is not applicable to Push messaging.
**Syntax:** `setSenderId(senderId)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :----- | :----------------------- |
| senderId | string | Specifies the sender id. |
## setQuickReplyData(icQuickReplyData)
This method is used to set the value of ICQuickReplyData that needs to be sent as part of the message.
**Syntax:** icMessage.setQuickReplyData(icQuickReplyData)
**Parameter:** ICQuickReplyData instance
## setTopic
This method is used to set the topic on which the message should be published. This method is not applicable to Push messaging.
**Syntax:** `String setTopic(topic)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :----- | :------------------- |
| topic | string | Specifies the topic. |
## getAttachments
This method is used to get the attachment files that are attached to the message.
**Syntax:** `ICAttachment[] getAttachments()`
**Return Type:** Returns the attachment files attached to the message.
## getThread
This method is used to get the thread details specified in the message.
**Syntax:** `ICThread getThread()`
**Return Type:** Returns the thread details that were specified in the message.
## getSubmitted
This method is used to get the message submitted date to the Webex Connect platform.
**Syntax:** `Date getSubmittedAt()`
**Return Type:** Returns the message submitted date to the Webex Connect platform.
## getDelivered
This method is used to get the message delivered date to the device.
**Syntax:** `Date getDeliveredAt()`
**Return Type:** Returns the message delivered date to the device.
## getReadAt
This method is used to get the message read date at the device.
**Syntax:** `Date getReadAt()`
**Return Type:** Returns the message read date at the device.
## getType
This method is used to get the message type.
**Syntax:** `ICMessageType getType()`
**Return Type:** Returns the message type.
## setAttachments
This method is used to set the media file attachments to be sent with an outgoing RTM. This method is not applicable to Push messaging.
**Syntax:** `setAttachments(final ICAttachment[] attachments)`
**Parameters:**
| Parameter | Type | Description |
| :---------- | :--- | :--------------------------- |
| attachments | | Refer to ICAttachment class. |
## setThread
This method is used to set the thread details that need to be specified in the message.
**Syntax:** `setThread(final ICThread thread)`
**Parameters:**
| Parameter | Type | Description |
| :-------- | :--- | :----------------------- |
| thread | | Refer to ICThread class. |
## setRelatedTransactionId
Use the property to set related transaction ID while submitting a form response.
**Syntax:** `ICMessage.setRelatedTransactionId(relatedTransactioId)`
```javascript
message.setThread(this.thread);
message.setRelatedTransactionId(formMT.getTransactionId());
```
## getRelatedTransactionId
This method returns a relatedTransactionID which can be used to identify original Form MO.
**Syntax:** `ICMessage. getRelatedTransactionId()`
**Returns:** `String`
## getInteractiveData()
This method returns details about the form-response.
> π Note
>
> This does not return the actual form response details.
**Syntax:** `ICMessage.getInteractiveData()`
**Returns:** `ICInteractiveData object`
## getTemporaryId()
This method is used to get TemporaryId of an ICMessage instance. A TemporaryId is generated only for locally republished messages with status ICMessageStatus.NotSent.
Syntax: `let id = icMessageInstance.getTemporaryId()`
Return Value: A string representing the temporary ID of the message.
## IMI.ICMediaFile
This class is **deprecated**.\
This class exposes data relating to media file attachments that are received through RTM and used to attach media files to outgoing messages.
[block:html]
{
"html": "\n\n\n\n\n\n\n\n| Public Methods | \n \n|
|---|---|
| String | \ngetContentType() | \n
| long | \ngetDuration() | \n
| double | \ngetLatitude() | \n
| double | \ngetLongitude() | \n
| String | \ngetPreview() | \n
| long | \ngetSize() | \n
| String | \ngetURL() | \n
| \n | setContentType(contentType) | \n
| \n | setDuration(duration) | \n
| \n | setLatitude(latitude) | \n
| \n | setLongitude(longitude) | \n
| \n | setPreview(preview) | \n
| \n | setSize(size) | \n
| \n | setURL(url) | \n
| Public Methods | \n \n|
|---|---|
| String | \ngetContentType() | \n
| long | \ngetDuration() | \n
| double | \ngetLatitude() | \n
| double | \ngetLongitude() | \n
| String | \ngetPreview() | \n
| long | \ngetSize() | \n
| String | \ngetURL() | \n
| \n | setContentType(contentType) | \n
| \n | setDuration(duration) | \n
| \n | setLatitude(latitude) | \n
| \n | setLongitude(longitude) | \n
| \n | setPreview(preview) | \n
| \n | setSize(size) | \n
| \n | setURL(url) | \n
| Public Methods | \n \n|
|---|---|
| String | \ngetId | \n
| String | \ngetTitle | \n
| boolean | \nisWritable | \n
| String | \ngetStreamName | \n
| Date | \ngetCreatedAt | \n
| Date | \ngetUpdatedAt | \n
| JSON | \nsetExtras | \n
| JSON | \ngetExtras | \n
| Number | \ngetUnreadMessageCount | \n