ICInteractiveData

ICInteractiveData

This class represents the data for user interaction on message

getType

This method is used to get the interactive data type for message

Syntax: public ICInteractiveDataType getType()

Returns: interactive data type for message

setType

This method sets the type of the Interactive Data.

Syntax: public void setType(ICInteractiveDataType type)

Parameters: type - type of the Interactive Data

getSubmittedAt

Returns the date on which the interaction data was submitted to the Webex Connect platform.

Syntax: public java.util.Date getSubmittedAt()

Returns: interaction data submitted date

setSubmittedAt

Sets the date on which the interaction data was submitted to the Webex Connect platform

Syntax: public void setSubmittedAt(java.util.Date submittedAt)

Parameters: submittedAt - The date on which the message interaction data was submitted.

setTid (Deprecated)

This method sets the transaction id for form response message.

Syntax: public void setTid(java.lang.String tid)

Parameters: tid  - transaction id that uniquely identifies the form response message

getTid (Deprecated)

This method gets the transaction id for form response message.

Syntax: public void getTid(java.lang.String tid)

Parameters: tid  - transaction id that uniquely identifies the form response message

getPayload

This method gets interactive payload data

Syntax: public org.json.JSONObject getPayload()

Returns: interactive payload data

toJSON

This method returns a new JSONObject instance containing message interactive data.

Syntax: public org.json.JSONObject toJSON()
throws org.json.JSONException

Returns: A JSONObject representation of the message interactive data.

Throws: org.json.JSONException

fromJSON

Instantiates a new ICInteractiveData instance from the supplied JSONObject.

Syntax: public static ICInteractiveData fromJSON(org.json.JSONObject jsonObject)

Parameters: jsonObject - A valid JSONObject instance containing message interactive data.

Returns: A new ICInteractiveData or null if jsonObj is null.

getRelatedTransactionId

This method is used to return related transaction id for the message.

Syntax:  String getRelatedTransactionId()

Return Value: Related transaction id.

setIdentifier

This method to set the identifier for the interactive data.

Syntax:  void setIdentifier(String identifier)

Parameters:

Parameter

Type

Description

identifier

String

Identifier for interactive data

getIdentifier

This method is used to return identifier for interactive data.

Syntax:  String getIdentifier()

Return Value: Identifier for interactive data.

setActionURL

This method to set the action URL for the interactive data.

Syntax:  void setActionURL(URL url)

Parameters: 

Parameter

Type

Description

url

URL

The action URL for the interactive data

getActionURL

This method is used to return action URL for interactive data.

Syntax:  URL getActionURL()

Return Value: action URL for the interactive data.

setTitle

This method to set the title for the interactive data.

Syntax:  void setTitle(String title)

Parameters: 

Parameter

Type

Description

title

String

The title for the interactive data.

getTitle

This method is used to return title for interactive data.

Syntax:  String getTitle()

Return Value: title for the interactive data.

setReference

This method to set the reference for the interactive data.

Syntax:  void setReference(String reference)

Parameters: 

Parameter

Type

Description

reference

String

The reference for the interactive data.

getReference

This method is used to return reference for interactive data.

Syntax:  String getReference()

Return Value: Reference for the interactive data.