ChatterMessages クラス

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterConversation getConversation(String conversationId)

パラメータ

conversationId

型: String

会話の ID を指定します。

戻り値

型: ConnectApi.​Chatter​Conversation

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 に設定されます。

戻り値

型: ConnectApi.​Chatter​Conversation

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId

型: String

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

conversationId

型: String

会話の ID を指定します。

戻り値

型: ConnectApi.​Chatter​Conversation

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 に設定されます。

戻り値

型: ConnectApi.​Chatter​Conversation

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterConversationPage getConversations()

戻り値

型: ConnectApi.​Chatter​ConversationPage

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

pageParam

型: String

情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.​Chatter​ConversationPage

API バージョン

30.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterConversationPage getConversations(String communityId)

パラメータ

communityId

型: String

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

戻り値

型: ConnectApi.​Chatter​ConversationPage

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 に設定されます。

戻り値

型: ConnectApi.​Chatter​ConversationPage

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterMessage getMessage(String messageId)

パラメータ

messageId

型: String

メッセージの ID。

戻り値

型: ConnectApi.​Chatter​Message

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId

型: String

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

messageId

型: String

メッセージの ID。

戻り値

型: ConnectApi.​Chatter​Message

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterMessagePage getMessages()

戻り値

型: ConnectApi.​Chatter​MessagePage

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

pageParam

型: String

情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.​Chatter​MessagePage

API バージョン

30.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterMessagePage getMessages(String communityId)

パラメータ

communityId

型: String

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

戻り値

型: ConnectApi.​Chatter​MessagePage

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 に設定されます。

戻り値

型: ConnectApi.​Chatter​MessagePage

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UnreadConversationCount getUnreadCount()

戻り値

型: ConnectApi.​​UnreadConversationCount

未読の会話の 50 個以下の場合、ConnectApi.UreadConversationCount で未読の会話の正確な数が返され、hasMore プロパティが false になります。未読の会話が 50 個を超えている場合、ConnectApi.UreadConversationCount で 50 個の未読の会話が返され、hasMore プロパティが true になります。

例

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

API バージョン

30.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UnreadConversationCount getUnreadCount(String communityId)

パラメータ

communityId

型: String

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

戻り値

型: ConnectApi.​​UnreadConversationCount

未読の会話の 50 個以下の場合、ConnectApi.UreadConversationCount で未読の会話の正確な数が返され、hasMore プロパティが false になります。未読の会話が 50 個を超えている場合、ConnectApi.UreadConversationCount で 50 個の未読の会話が返され、hasMore プロパティが true になります。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

conversationId

型: String

会話の ID を指定します。

read

型: Boolean

会話が既読か (true)、否か (false) を示します。

戻り値

型: ConnectApi.​Chatter​ConversationSummary

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.​Chatter​ConversationSummary

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

text

型: String

メッセージのテキスト。空にはできず、10,000 文字を超えることはできません。

inReplyTo

型: String

応答されるメッセージの ID。

戻り値

型: ConnectApi.​Chatter​Message

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。

戻り値

型: ConnectApi.​Chatter​Message

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

conversationId

型: String

会話の ID を指定します。

q

型: String

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

戻り値

型: ConnectApi.​Chatter​Conversation

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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

型: ConnectApi.​Chatter​Conversation

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

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

戻り値

型: ConnectApi.​Chatter​Conversation

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

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

戻り値

型: ConnectApi.​Chatter​Conversation

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterConversationPage searchConversations(String q)

パラメータ

q

型: String

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

戻り値

型: ConnectApi.​Chatter​ConversationPage

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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

型: ConnectApi.​Chatter​ConversationPage

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId

型: String

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

q

型: String

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

戻り値

型: ConnectApi.​Chatter​ConversationPage

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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

型: ConnectApi.​Chatter​ConversationPage

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterMessagePage searchMessages(String q)

パラメータ

q

型: String

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

戻り値

型: ConnectApi.​Chatter​MessagePage

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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

型: ConnectApi.​Chatter​MessagePage

API バージョン

30.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId

型: String

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

q

型: String

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

戻り値

型: ConnectApi.​Chatter​MessagePage

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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

型: ConnectApi.​Chatter​MessagePage

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメータ

text

型: String

メッセージのテキスト。空にはできず、10,000 文字を超えることはできません。

recipients

型: String

メッセージを受信する最大 9 ユーザのカンマ区切りの ID。

戻り値

型: ConnectApi.​Chatter​Message

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。

戻り値

型: ConnectApi.​Chatter​Message