ChatterMessages Class

Get, send, search, and reply to private messages. You can also get and search private conversations, mark conversations as read, and get a count of unread private messages.

ConnectApi

Private messages and direct messages are different features. Direct messages are newer and offer a richer feature set for private communication in Experience Cloud sites. Direct messages are a capability within Chatter feeds. To work with direct messages, use the ChatterFeeds Class.

These methods are for ChatterMessages. All methods are static.

All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.

Get a conversation.

29.0

Yes

public static ConnectApi.ChatterConversation getConversation(String conversationId)

conversationId

Type: String

ID for the conversation.

Type: ConnectApi.​Chatter​Conversation

Get a page of a conversation.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​Conversation

Get a conversation from an Experience Cloud site.

30.0

Yes

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

communityId

Type:String

ID for an Experience Cloud site, internal, or null.

conversationId

Type: String

ID for the conversation.

Type: ConnectApi.​Chatter​Conversation

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​Conversation

Get the most recent conversations.

29.0

Yes

public static ConnectApi.ChatterConversationPage getConversations()

Type: ConnectApi.​Chatter​ConversationPage

Get a page of conversations.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​ConversationPage

Get the most recent conversations from an Experience Cloud site.

30.0

Yes

public static ConnectApi.ChatterConversationPage getConversations(String communityId)

communityId

Type:String

ID for an Experience Cloud site, internal, or null.

Type: ConnectApi.​Chatter​ConversationPage

Get a page of conversations from an Experience Cloud site.

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​ConversationPage

Get a message.

29.0

Yes

public static ConnectApi.ChatterMessage getMessage(String messageId)

messageId

Type: String

ID for the message.

Type: ConnectApi.​Chatter​Message

Get a message from an Experience Cloud site.

30.0

Yes

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

communityId

Type:String

ID for an Experience Cloud site, internal, or null.

messageId

Type: String

ID for the message.

Type:ConnectApi.​Chatter​Message

Get the most recent messages.

29.0

Yes

public static ConnectApi.ChatterMessagePage getMessages()

Type: ConnectApi.​Chatter​MessagePage

Get a page of messages.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​MessagePage

Get the most recent messages from an Experience Cloud site.

30.0

Yes

public static ConnectApi.ChatterMessagePage getMessages(String communityId)

communityId

Type:String

ID for an Experience Cloud site, internal, or null.

Type: ConnectApi.​Chatter​MessagePage

Get a page of messages from an Experience Cloud site.

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​MessagePage

Get the number of conversations that are marked unread.

29.0

Yes

public static ConnectApi.UnreadConversationCount getUnreadCount()

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.

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

30.0

Yes

public static ConnectApi.UnreadConversationCount getUnreadCount(String communityId)

communityId

Type:String

ID for an Experience Cloud site, internal, or null.

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.

Mark a conversation as read or unread.

29.0

Yes

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

conversationId

Type: String

ID for the conversation.

read

Type: Boolean

Specify whether the conversation is read (true) or not (false).

Type: ConnectApi.​Chatter​ConversationSummary

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

30.0

Yes

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

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).

Type: ConnectApi.​Chatter​ConversationSummary

Reply to a message.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​Message

Reply to a message in an Experience Cloud site.

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​Message

Get a conversation that matches the search criteria.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​Conversation

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

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​Conversation

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​Conversation

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​Conversation

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

29.0

Yes

public static ConnectApi.ChatterConversationPage searchConversations(String q)

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.

Type: ConnectApi.​Chatter​ConversationPage

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

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​ConversationPage

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​ConversationPage

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​ConversationPage

Get messages that match the search criteria.

29.0

Yes

public static ConnectApi.ChatterMessagePage searchMessages(String q)

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.

Type: ConnectApi.​Chatter​MessagePage

Get a page of messages that match the search criteria.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​MessagePage

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​MessagePage

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​MessagePage

Send a message to a list of recipients.

29.0

Yes

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

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.

Type: ConnectApi.​Chatter​Message

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

30.0

Yes

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

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.

Type: ConnectApi.​Chatter​Message