ChatterMessages クラス

getConversation(conversationId, pageParam, pageSize)

コンテキストユーザがアクセスできる 1 つの会話を返します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

conversationId: 型: String; 会話の ID を指定します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getConversation(communityId, conversationId)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる会話を返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
conversationId: 型: String; 会話の ID を指定します。

戻り値

Chatter の会話および関連するメタデータ。

getConversation(communityId, conversationId, pageParam, pageSize)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる会話のうち、特定の数の結果を含む特定のページからの会話を返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
conversationId: 型: String; 会話の ID を指定します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

Chatter の会話および関連するメタデータ。

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)

パラメータ

pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getConversations(communityId)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる最近の会話を返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterConversationPage getConversations(String communityId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。

戻り値

特定のページの Chatter の会話のリスト。

getConversations(communityId, pageParam, pageSize)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる会話のうち、特定の数の結果を含む会話の特定のページを返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

特定のページの Chatter の会話のリスト。

getMessage(messageId)

コンテキストユーザがアクセスできる 1 つのメッセージを返します。

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)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
messageId: 型: String; メッセージの ID を指定します。

戻り値

Chatter メッセージおよび関連するすべてのメタデータ。

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)

パラメータ

pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getMessages(communityId)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる最近のメッセージのリストを返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterMessagePage getMessages(String communityId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。

戻り値

特定のページの Chatter メッセージ。

getMessages(communityId, pageParam, pageSize)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできるメッセージのうち、指定された数の結果を含むメッセージの指定されたページを返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

特定のページの Chatter メッセージ。

getUnreadCount()

コンテキストユーザが未読とマークした会話の数を返します。数が 50 より小さい場合は、正確な unreadCount と hasMore = false を返します。コンテキストユーザに 50 を超える未読の会話がある場合は、unreadCount = 50 と hasMore = true を返します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UnreadConversationCount getUnreadCount()

戻り値

型: ConnectApi.UnreadConversationCount

例

getUnreadCount(communityId)

使用可能なコミュニティでコンテキストユーザが未読とマークした会話の数を返します。数が 50 より小さい場合は、正確な unreadCount と hasMore = false を返します。コンテキストユーザに 50 を超える未読の会話がある場合は、unreadCount = 50 と hasMore = true を返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UnreadConversationCount getUnreadCount(String communityId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。

戻り値

型: ConnectApi.UnreadConversationCount

会話内の未読メッセージの数。

markConversationRead(conversationId, read)

コンテキストユーザの会話を既読としてマークします。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

conversationId: 型: String; 会話の ID を指定します。
read: 型: Boolean; 会話が既読か (true)、否か (false) を示します。

戻り値

型: ConnectApi.ChatterConversationSummary

markConversationRead(communityId, conversationID, read)

使用可能なコミュニティ全体でコンテキストユーザの会話を既読または未読としてマークします。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
conversationId: 型: String; 会話の ID を指定します。
read: 型: Boolean; 会話が既読か (true)、否か (false) を示します。

戻り値

型: ConnectApi.ChatterConversationSummary

会話のメンバー、Chatter REST API URL、最新メッセージの内容などの、Chatter の会話の概要。

replyToMessage(text, inReplyTo)

指定されたテキストをコンテキストユーザがアクセスできる、先行するメッセージへの応答として追加します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

text: 型: String; メッセージのテキスト。空にはできず、10,000 文字を超えることはできません。
inReplyTo: 型: String; 応答されるメッセージの ID を指定します。

戻り値

replyToMessage(communityId, text, inReplyTo)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる先行するメッセージへの応答として、指定されたテキストを追加します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
text: 型: String; メッセージのテキスト。空にはできず、10,000 文字を超えることはできません。
inReplyTo: 型: String; 応答されるメッセージの ID を指定します。

戻り値

Chatter メッセージおよび関連するすべてのメタデータ。

searchConversation(conversationId, q)

指定された検索条件に一致するメッセージが含まれるページとともに、コンテキストユーザがアクセスできる会話を返します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

conversationId: 型: String; 会話の ID を指定します。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

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; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

searchConversation(communityId, conversationId, q)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる会話のうち、指定された検索のいずれかに一致するメッセージのページが含まれる会話を返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
conversationId: 型: String; 会話の ID を指定します。
q: 型: String; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

Chatter の会話および関連するメタデータ。

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; コミュニティの ID、internal、または null のいずれかを使用します。
conversationId: 型: String; 会話の ID を指定します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
q: 型: String; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

Chatter の会話および関連するメタデータ。

searchConversations(q)

コンテキストユーザがアクセスできる会話のうち、会話内のメンバー名とメッセージが指定された検索条件のいずれかと一致する��話のページを返します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterConversationPage searchConversations(String q)

パラメータ

q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

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)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

特定のページの Chatter の会話のリスト。

searchConversations(communityId, pageParam, pageSize, q)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできる会話のうち、会話内のメンバー名とメッセージが指定された検索条件のいずれかと一致した会話から、指定された数の結果を含む会話の特定のページを返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

特定のページの Chatter の会話のリスト。

searchMessages(q)

コンテキストユーザがアクセスできるメッセージのうち、指定された条件のいずれかに一致するメッセージのページを返します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterMessagePage searchMessages(String q)

パラメータ

q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

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)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

特定のページの Chatter メッセージ。

searchMessages(communityId, pageParam, pageSize, q)

使用可能なコミュニティ全体でコンテキストユーザがアクセスできるメッセージのうち、指定された条件のいずれかに一致する、指定された数の結果を含むメッセージの特定のページを返します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
pageParam: 型: String; 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

特定のページの Chatter メッセージ。

sendMessage(text, recipients)

指定されたテキストを指示された受信者に送信します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

text: 型: String; メッセージのテキスト。空にはできず、10,000 文字を超えることはできません。
recipients: 型: String; メッセージを受信する最大 9 ユーザのカンマ区切りの ID。

戻り値

sendMessage(communityId, text, recipients)

使用可能なコミュニティ全体で、指示された受信者に指定されたテキストを送信します。

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
text: 型: String; メッセージのテキスト。空にはできず、10,000 文字を超えることはできません。
recipients: 型: String; メッセージを受信する最大 9 ユーザのカンマ区切りの ID。

戻り値