ChatterMessages Class

getConversation(conversationId, pageParam, pageSize)

Get a page of a conversation.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation getConversation(String conversationId, String pageParam, Integer pageSize)

Parameters

conversationId: Type: String; ID for the conversation.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getConversation(communityId, conversationId)

Get a conversation from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation getConversation(String communityId, String conversationId)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
conversationId: Type: String; ID for the conversation.

Return Value

getConversation(communityId, conversationId, pageParam, pageSize)

Get a page of a conversation from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation getConversation(String communityId, String conversationId, String pageParam, String pageSize)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
conversationId: Type: String; ID for the conversation.
pageParam: Type:String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getConversations()

Get the most recent conversations.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage getConversations()

Return Value

getConversations(pageParam, pageSize)

Get a page of conversations.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage getConversations(String pageParam, Integer pageSize)

Parameters

pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getConversations(communityId)

Get the most recent conversations from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage getConversations(String communityId)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.

Return Value

getConversations(communityId, pageParam, pageSize)

Get a page of conversations from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage getConversations(String communityId, String pageParam, Integer pageSize)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
pageParam: Type:String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getMessage(messageId)

Get a message.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessage getMessage(String messageId)

Parameters

messageId: Type: String; ID for the message.

Return Value

getMessage(communityId, messageId)

Get a message from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessage getMessage(String communityId, String messageId)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
messageId: Type: String; ID for the message.

Return Value

Type:ConnectApi.ChatterMessage

getMessages()

Get the most recent messages.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage getMessages()

Return Value

getMessages(pageParam, pageSize)

Get a page of messages.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage getMessages(String pageParam, Integer pageSize)

Parameters

pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getMessages(communityId)

Get the most recent messages from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage getMessages(String communityId)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.

Return Value

getMessages(communityId, pageParam, pageSize)

Get a page of messages from an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage getMessages(String communityId, String pageParam, Integer pageSize)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getUnreadCount()

Get the number of conversations that are marked unread.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.UnreadConversationCount getUnreadCount()

Return Value

Type: ConnectApi.UnreadConversationCount

If there are fewer than 50 unread conversations, ConnectApi.UreadConversationCount returns the exact number of unread conversations and the hasMore property is false. If there are more than 50 unread conversations, ConnectApi.UreadConversationCount returns 50 unread conversations and the hasMore property is true.

Example

1ConnectApi.UnreadConversationCount unread = ConnectApi.ChatterMessages.getUnreadCount();

getUnreadCount(communityId)

Get the number of conversations that are marked unread in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.UnreadConversationCount getUnreadCount(String communityId)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.

Return Value

Type: ConnectApi.UnreadConversationCount

markConversationRead(conversationId, read)

Mark a conversation as read or unread.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationSummary markConversationRead(String conversationId, Boolean read)

Parameters

conversationId: Type: String; ID for the conversation.
read: Type: Boolean; Specify whether the conversation is read (true) or not (false).

Return Value

Type: ConnectApi.ChatterConversationSummary

markConversationRead(communityId, conversationID, read)

Mark a conversation as read or unread in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationSummary markConversationRead(String communityId, String conversationID, Boolean read)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
conversationId: Type: String; ID for the conversation.
read: Type: Boolean; Specify whether the conversation is read (true) or not (false).

Return Value

Type: ConnectApi.ChatterConversationSummary

replyToMessage(text, inReplyTo)

Reply to a message.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessage replyToMessage(String text, String inReplyTo)

Parameters

text: Type: String; Text of the message. Can’t be empty or over 10,000 characters.
inReplyTo: Type: String; ID of the message that is being responded to.

Return Value

replyToMessage(communityId, text, inReplyTo)

Reply to a message in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessage replyToMessage(String communityId, String text, String inReplyTo)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
text: Type: String; Text of the message. Can’t be empty or over 10,000 characters.
inReplyTo: Type: String; ID of the message that is being responded to.

Return Value

searchConversation(conversationId, q)

Get a conversation that matches the search criteria.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation searchConversation(String conversationId, String q)

Parameters

conversationId: Type: String; ID for the conversation.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversation(conversationId, pageParam, pageSize, q)

Get a conversation with a page of messages that match the search criteria.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation searchConversation(String conversationId, String pageParam, Integer pageSize, String q)

Parameters

conversationId: Type: String; ID for the conversation.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversation(communityId, conversationId, q)

Get a conversation with messages that match the search criteria in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation searchConversation(String communityId, String conversationId, String q)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
conversationId: Type: String; ID for the conversation.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversation(communityId, conversationId, pageParam, pageSize, q)

Get a conversation with a page of messages that match the search criteria in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversation searchConversation(String communityId, String conversationId, String pageParam, Integer pageSize, String q)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
conversationId: Type: String; ID for the conversation.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversations(q)

Get conversations in which member names and messages match the search criteria.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage searchConversations(String q)

Parameters

q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversations(pageParam, pageSize, q)

Get a page of conversations in which member names and messages match the search criteria.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage searchConversations(String pageParam, Integer pageSize, String q)

Parameters

pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversations(communityId, q)

Get conversations in which member names and messages match the search criteria in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage searchConversations(String communityId, String q)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchConversations(communityId, pageParam, pageSize, q)

Get a page of conversations in which member names and messages match the search criteria in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterConversationPage searchConversations(String communityId, String pageParam, Integer pageSize, String q)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchMessages(q)

Get messages that match the search criteria.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage searchMessages(String q)

Parameters

q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchMessages(pageParam, pageSize, q)

Get a page of messages that match the search criteria.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage searchMessages(String pageParam, Integer pageSize, String q)

Parameters

pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchMessages(communityId, q)

Get messages that match the search criteria in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage searchMessages(String communityId, String q)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

searchMessages(communityId, pageParam, pageSize, q)

Get a page of messages that match the search criteria in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessagePage searchMessages(String communityId, String pageParam, Integer pageSize, String q)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
pageParam: Type: String; Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

sendMessage(text, recipients)

Send a message to a list of recipients.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessage sendMessage(String text, String recipients)

Parameters

text: Type: String; Text of the message. Can’t be empty or over 10,000 characters.
recipients: Type: String; Up to nine comma-separated IDs of the users receiving the message.

Return Value

sendMessage(communityId, text, recipients)

Send a message to a list of recipients in an Experience Cloud site.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterMessage sendMessage(String communityId, String text, String recipients)

Parameters

communityId: Type:String; ID for an Experience Cloud site, internal, or null.
text: Type: String; Text of the message. Can’t be empty or over 10,000 characters.
recipients: Type: String; Up to nine comma-separated IDs of users to receive the message.

Return Value