ICTopic
This class represents a topic within the Webex Connect platform.
Webex Connect supports topic-based messaging, where users may subscribe to, and receive messages on, specific topics of interest.
Return Type | Method |
---|---|
ICTopic | fromJSON(JSONObject) |
Date | getCreatedOn() |
String | getDescription() |
String | getGroup() |
String | getId() |
String | getName() |
String | getTitle() |
boolean | isSubscribed() |
JSONObject | toJSON() |
fromJSON
Instantiates a topic from the JSON representation. The JSONObject must contain valid topic data.
Syntax: static ICTopic fromJSON(JSONObject jsonObj)
Return Value: A new topic instance, or null if jsonObj is null.
getCreatedOn
Returns the date on which the topic was created.
Syntax: Date getCreatedOn()
Return Value: Returns the date on which the topic was created.
getDescription
This method is used to get the topic description.
Syntax: String getDescription()
Return Value: Returns description of topic.
getGroup
This method is used to get the topic’s group.
Syntax: String getGroup()
Return Value: Returns the topic's group.
getId
This method is used to get topic Id.
The topic id is an internal identifier used as the primary key by Webex Connect.
Syntax: String getId()
Return Value: Returns the Id for the Topic.
getName
Returns the name of the topic.
The topic name is the textual identifier used to reference the topic within Webex Connect.
Syntax: String getName()
Return Value: Returns the name of the topic.
getTitle
Gets the title of the topic.
The topic title is intended as the user-friendly value that may be used to populate a UI.
Syntax: String getTitle()
Return Value: Returns the topic title.
isSubscribed
Returns whether the current user is subscribed to the topic.
Syntax: boolean isSubscribed()
Return Value: Returns true if the current user is subscribed to the topic.
toJSON
Returns a JSON representation of the topic.
Syntax: JSONObject toJSON()
Return Value: The topic as a JSONObject.
Updated about 1 year ago