Apex リファレンスガイド
jChatterMessages クラス
名前空間
使用方法
非公開メッセージとダイレクトメッセージは異なる機能です。ダイレクトメッセージの方が新しく、Experience Cloud サイトで非公開コミュニケーションに関するより豊富な機能セットを利用できます。ダイレクトメッセージは、Chatter フィードの機能です。ダイレクトメッセージを操作するには、ChatterFeeds クラスを使用します。
ChatterMessages のメソッド
getConversation(conversationId)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation getConversation(String conversationId)
パラメーター
- conversationId
- 型: String
- 会話の ID。
getConversation(conversationId, pageParam, pageSize)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation getConversation(String conversationId, String pageParam, Integer pageSize)
パラメーター
getConversation(communityId, conversationId)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation getConversation(String communityId, String conversationId)
パラメーター
getConversation(communityId, conversationId, pageParam, pageSize)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation getConversation(String communityId, String conversationId, String pageParam, String pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- conversationId
- 型: String
- 会話の ID。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
getConversations()
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage getConversations()
getConversations(pageParam, pageSize)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage getConversations(String pageParam, Integer pageSize)
パラメーター
getConversations(communityId)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage getConversations(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
getConversations(communityId, pageParam, pageSize)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage getConversations(String communityId, String pageParam, Integer pageSize)
パラメーター
getMessage(messageId)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessage getMessage(String messageId)
パラメーター
- messageId
- 型: String
- メッセージの ID。
戻り値
getMessage(communityId, messageId)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessage getMessage(String communityId, String messageId)
パラメーター
戻り値
getMessages()
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage getMessages()
getMessages(pageParam, pageSize)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage getMessages(String pageParam, Integer pageSize)
パラメーター
getMessages(communityId)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage getMessages(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
getMessages(communityId, pageParam, pageSize)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage getMessages(String communityId, String pageParam, Integer pageSize)
パラメーター
getUnreadCount()
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.UnreadConversationCount getUnreadCount()
戻り値
型: ConnectApi.UnreadConversationCount
未読の会話の 50 個以下の場合、ConnectApi.UreadConversationCount で未読の会話の正確な数が返され、hasMore プロパティが false になります。未読の会話が 50 個を超えている場合、ConnectApi.UreadConversationCount で 50 個の未読の会話が返され、hasMore プロパティが true になります。
例
getUnreadCount(communityId)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.UnreadConversationCount getUnreadCount(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
戻り値
型: ConnectApi.UnreadConversationCount
未読の会話の 50 個以下の場合、ConnectApi.UreadConversationCount で未読の会話の正確な数が返され、hasMore プロパティが false になります。未読の会話が 50 個を超えている場合、ConnectApi.UreadConversationCount で 50 個の未読の会話が返され、hasMore プロパティが true になります。
markConversationRead(conversationId, read)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationSummary markConversationRead(String conversationId, Boolean read)
markConversationRead(communityId, conversationID, read)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationSummary markConversationRead(String communityId, String conversationID, Boolean read)
パラメーター
replyToMessage(text, inReplyTo)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessage replyToMessage(String text, String inReplyTo)
戻り値
replyToMessage(communityId, text, inReplyTo)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessage replyToMessage(String communityId, String text, String inReplyTo)
パラメーター
戻り値
searchConversation(conversationId, q)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation searchConversation(String conversationId, String q)
パラメーター
��り値
searchConversation(conversationId, pageParam, pageSize, q)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation searchConversation(String conversationId, String pageParam, Integer pageSize, String q)
パラメーター
- conversationId
- 型: String
- 会話の ID。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchConversation(communityId, conversationId, q)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation searchConversation(String communityId, String conversationId, String q)
パラメーター
searchConversation(communityId, conversationId, pageParam, pageSize, q)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversation searchConversation(String communityId, String conversationId, String pageParam, Integer pageSize, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- conversationId
- 型: String
- 会話の ID。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchConversations(q)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage searchConversations(String q)
パラメーター
searchConversations(pageParam, pageSize, q)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage searchConversations(String pageParam, Integer pageSize, String q)
パラメーター
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchConversations(communityId, q)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage searchConversations(String communityId, String q)
パラメーター
searchConversations(communityId, pageParam, pageSize, q)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterConversationPage searchConversations(String communityId, String pageParam, Integer pageSize, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchMessages(q)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage searchMessages(String q)
パラメーター
searchMessages(pageParam, pageSize, q)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage searchMessages(String pageParam, Integer pageSize, String q)
パラメーター
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchMessages(communityId, q)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage searchMessages(String communityId, String q)
パラメーター
searchMessages(communityId, pageParam, pageSize, q)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessagePage searchMessages(String communityId, String pageParam, Integer pageSize, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
sendMessage(text, recipients)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterMessage sendMessage(String text, String recipients)