ChatterGroups クラス

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMember addMember(String communityId, String groupId, String userId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

userId

型: String

ユーザの ID。

戻り値

型: ConnectApi.​GroupMember

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMember addMemberWithRole(String communityId, String groupId, String userId, ConnectApi.GroupMembershipType role)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

userId

型: String

ユーザの ID。

role

型: ConnectApi.GroupMembershipType

グループメンバーシップの種別。次のいずれかの値にします。

• GroupManager
• StandardMember

戻り値

型: ConnectApi.​GroupMember

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupDetail createGroup(String, communityId, ConnectApi.ChatterGroupInput groupInput)

パラメータ

communityId

型: String

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

groupInput

型: ConnectApi.Chatter​​GroupInput

グループのプロパティ。

戻り値

型: ConnectApi.​Chatter​Group​Detail

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static Void deleteMember(String communityId, String membershipId)

パラメータ

communityId

型: String

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

membershipId

型: String

メンバーシップの ID。

戻り値

型: Void

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static Void deletePhoto(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: Void

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.AnnouncementPage

使用方法

お知らせを投稿するには、postAnnouncement(String, String, String, ConnectApi.AnnouncementInput) をコールします。

特定のお知らせに関する情報の取得、お知らせの表示期限の更新、またはお知らせの削除を行うには、ConnectApi.Announcements クラスのメソッドを使用します。

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String groupId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

戻り値

型: ConnectApi.AnnouncementPage

使用方法

お知らせを投稿するには、postAnnouncement(String, String, String, ConnectApi.AnnouncementInput) をコールします。

特定のお知らせに関する情報の取得、お知らせの表示期限の更新、またはお知らせの削除を行うには、ConnectApi.Announcements クラスのメソッドを使用します。

API バージョン

28.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupDetail getGroup(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.​Chatter​Group​Detail

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BatchResult[] getGroupBatch(String communityId, List<String> groupIds)

パラメータ

communityId

型: String

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

groupIds

型: List<String>

最大 500 件のグループ ID のリスト。

戻り値

型: BatchResult[]

BatchResult.getResult() メソッドは ConnectApi.ChatterGroup オブジェクトを返します。

例

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMembershipRequest getGroupMembershipRequest(String communityId, String requestId)

パラメータ

communityId

型: String

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

requestId

型: String

非公開グループへの参加要求の ID。

戻り値

型: ConnectApi.​Group​Membership​Request

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMembershipRequests getGroupMembershipRequests(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.Group​​MembershipRequests

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMembershipRequests getGroupMembershipRequests(String communityId, String groupId, ConnectApi.GroupMembershipRequestStatus status)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

status

型: ConnectApi.​GroupMembership​RequestStatus

status — 非公開グループへの参加要求の状況。

• Accepted
• Declined
• Pending

戻り値

型: ConnectApi.Group​​MembershipRequests

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

API バージョン

28.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage getGroups(String communityId)

パラメータ

communityId

型: String

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

戻り値

型: ConnectApi.Chatter​​​GroupPage

API バージョン

28.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage getGroups(String communityId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

pageParam

型: Integer

返すページのページ番号を指定します。0 か��開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

戻り値

型: ConnectApi.Chatter​​​GroupPage

API バージョン

29.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage getGroups(String communityId, Integer pageParam, Integer pageSize, ConnectApi.GroupArchiveStatus archiveStatus)

パラメータ

communityId

型: String

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

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

archiveStatus

型: ConnectApi.GroupArchiveStatus

グループがアーカイブ対象かどうかに基づいてグループのセットを指定します。

• All — アーカイブ対象かどうかに関係なく、すべてのグループ。
• Archived — アーカイブ対象のグループのみ。
• NotArchived — アーカイブ対象外のグループのみ。

null を渡すと、デフォルト値の All が使用されます。

戻り値

型: ConnectApi.Chatter​​​GroupPage

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMember getMember(String communityId, String membershipId)

パラメータ

communityId

型: String

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

membershipId

型: String

メンバーシップの ID。

戻り値

型: ConnectApi.​GroupMember

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMemberPage getMembers(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.Group​​MemberPage

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMemberPage getMembers(String communityId, String groupId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数。有効な値は 1 ～ 1000 です。null を渡すと、pageSize は 25 になります。

戻り値

型: ConnectApi.Group​​MemberPage

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BatchResult[] getMembershipBatch(String communityId, List<String> membershipIds)

パラメータ

communityId

型: String

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

membershipIds

型: List<String>

最大 500 件のグループメンバーシップ ID のリスト。

戻り値

型: BatchResult[]

BatchResult getResults() メソッドは、ConnectApi.GroupMember オブジェクトを返します。

例

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupChatterSettings getMyChatterSettings(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.Group​​ChatterSettings

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo getPhoto(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.Photo

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupRecordPage getRecords(String communityId, String groupId)

パラメータ

communityId

型: String

グループレコードは、コミュニティではサポートされていません。null または internal を指定します。

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.​GroupRecordPage

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupRecordPage getRecords(String communityId, String groupId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

グループレコードは、コミュニティではサポートされていません。null または internal を指定します。

groupId

型: String

グループの ID。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数。有効な値は 1 ～ 1000 です。null を渡すと、pageSize は 25 になります。

戻り値

型: ConnectApi.​GroupRecordPage

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Announcement postAnnouncement(String communityId, String groupId, ConnectApi.AnnouncementInput announcement)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

announcement

型: ConnectApi.AnnouncementInput

ConnectApi.AnnouncementInput オブジェクト。

戻り値

型: ConnectApi.Announcement

使用方法

お知らせは、情報を強調表示するために使用します。ユーザは、グループフィードのお知らせに対するディスカッション、いいね!、コメントの投稿ができます。他の投稿と同様に、お知らせが投稿されると、グループメンバーは選択したグループメール通知頻度に応じてメール通知を受信します。フィード投稿を削除するとお知らせが削除されます。

グループ内のすべてのお知らせに関する情報を取得するには、getAnnouncements(String, String) または getAnnouncements(String, String, Integer, Integer) をコールします。

特定のお知らせに関する情報の取得、お知らせの表示期限の更新、またはお知らせの削除を行うには、ConnectApi.Announcements クラスのメソッドを使用します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMembershipRequest requestGroupMembership(String communityId, String groupId)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.​Group​Membership​Request

サンプル: 非公開グループへの参加要求

このサンプルコードは ConnectApi.ChatterGroups.requestGroupMembership をコールして非公開グループへの参加要求を行います。

API バージョン

28.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q)

パラメータ

communityId

型: String

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

q

型: String

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

戻り値

型: ConnectApi.Chatter​​​GroupPage

API バージョン

28.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

q

型: String

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

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

戻り値

型: ConnectApi.Chatter​​​GroupPage

API バージョン

29.0

ゲストユーザが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q, ConnectApi.GroupArchiveStatus archiveStatus, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

q

型: String

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

archiveStatus

型: ConnectApi.GroupArchiveStatus

archiveStatus — グループがアーカイブ対象かどうかに基づいてグループのセットを指定します。

• All — アーカイブ対象かどうかに関係なく、すべてのグループ。
• Archived — アーカイブ対象のグループのみ。
• NotArchived — アーカイブ対象外のグループのみ。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

戻り値

型: ConnectApi.Chatter​​​GroupPage

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo setPhoto(String communityId, String groupId, String fileId, Integer versionNumber)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

fileId

型: String

すでにアップロードされたファイルの ID。ファイルは 2 MB 未満の画像にする必要があります。

versionNumber

型: Integer

既存ファイルのバージョン番号。既存のバージョン番号を指定するか、null を指定して最新バージョンを取得します。

戻り値

型: ConnectApi.Photo

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

写真は非同期に処理され、すぐには表示されない場合があります。

サンプル: 既存ファイルを使用したグループ写真の更新

グループを作成した時点では、グループ写真は含まれていません。Salesforce にすでにアップロードされている既存の写真をグループ写真として設定できます。キープレフィックスは 069 に、ファイルサイズは 2 MB 未満にする必要があります。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo setPhoto(String communityId, String groupId, ConnectApi.BinaryInput fileUpload)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

fileUpload

型: ConnectApi.Binary​​Input

写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.Photo

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

写真は非同期に処理され、すぐには表示されない場合があります。

サンプル: 新しいファイルをアップロードしてグループ写真として使用する

グループを作成した時点では、グループ写真は含まれていません。写真をアップロードし、グループ写真としてそれを設定できます。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String groupId, ConnectApi.PhotoInput photo)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

photo

型: ConnectApi.PhotoInput

ファイルの ID とバージョン、およびファイルのトリミング方法を指定する ConnectApi.PhotoInput オブジェクト。

戻り値

型: ConnectApi.Photo

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

写真は非同期に処理され、すぐには表示されない場合があります。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String groupId, ConnectApi.PhotoInput photo, ConnectApi.BinaryInput fileUpload)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

photo

型: ConnectApi.PhotoInput

fileUpload で指定されたファイルのトリミング方法を指定する ConnectApi.PhotoInput オブジェクト。

fileUpload

型: ConnectApi.Binary​​Input

写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.Photo

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

写真は非同期に処理され、すぐには表示されない場合があります。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroup updateGroup(String communityId, String groupId, ConnectApi.ChatterGroupInput groupInput)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

groupInput

型: ConnectApi.Chatter​​GroupInput

ConnectApi.ChatterGroupInput オブジェクト。

戻り値

型: ConnectApi.ChatterGroup

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。このメソッドを使用して、ConnectApi.ChatterGroupInput クラスの設定を更新します。これらの設定には、グループが公開されているか非公開であるか、グループがアーカイブされているかどうかに関わらず、[情報] セクションのグループタイトルとテキストが含まれます。

例

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroup updateGroupMember(String communityId, String membershipId, ConnectApi.GroupMembershipType role)

パラメータ

communityId

型: String

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

membershipId

型: String

メンバーシップの ID。

role

型: ConnectApi.GroupMembershipType

グループメンバーシップの種別。次のいずれかの値にします。

• GroupManager
• StandardMember

戻り値

型: ConnectApi.ChatterGroup

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupChatterSettings updateMyChatterSettings(String communityId, String groupId, ConnectApi.GroupEmailFrequency emailFrequency)

パラメータ

communityId

型: String

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

groupId

型: String

グループの ID。

emailFrequency

型: ConnectApi.​GroupEmail​Frequency

emailFrequency — グループからユーザがメールを受信する頻度を指定します。

• EachPost
• DailyDigest
• WeeklyDigest
• Never
• UseDefault

UseDefault の値は、updateChatterSettings(String, String, ConnectApi.GroupEmailFrequency) へのコールの値セットを使用します。

戻り値

型: ConnectApi.Group​​ChatterSettings

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupMembershipRequest updateRequestStatus(String communityId, String requestId, ConnectApi.GroupMembershipRequestStatus status)

パラメータ

communityId

型: String

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

requestId

型: String

非公開グループへの参加要求の ID。

status

型: ConnectApi.​GroupMembership​RequestStatus

要求の状況。

• Accepted
• Declined

このメソッドでは、Pending 値に Enum は使用できません。

戻り値

型: ConnectApi.​Group​Membership​Request

使用方法

このメソッドは、コンテキストユーザがグループ管理者または所有者であるか、「すべてのデータの編集」権限を持っている場合にのみ正常に実行されます。

サンプル: 非公開グループへの参加要求の受諾または拒否

このサンプルコードは ConnectApi.ChatterGroups.updateRequestStatus をコールし、それをメンバーシップ要求 ID と ConnectApi.GroupMembershipRequestStatus.Accepted 状況を渡します。また、ConnectApi.GroupMembershipRequestStatus.Declined を渡すこともできます。

API バージョン

29.0

署名

public static Void setTestSearchGroups(String communityId, String q, ConnectApi.ChatterGroupPage result)

パラメータ

communityId

型: String

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

q

型: String

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

result

型: ConnectApi.Chatter​​​GroupPage

テスト ConnectApi.ChatterGroupPage オブジェクト。

戻り値

型: Void

API バージョン

28.0

署名

public static Void setTestSearchGroups(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.ChatterGroupPage result)

パラメータ

communityId

型: String

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

q

型: String

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

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

result

型: ConnectApi.Chatter​​​GroupPage

テスト ConnectApi.ChatterGroupPage オブジェクト。

戻り値

型: Void

API バージョン

29.0

署名

public static Void setTestSearchGroups(String communityId, String q, ConnectApi.GroupArchiveStatus, archiveStatus, Integer pageParam, Integer pageSize, ConnectApi.ChatterGroupPage result)

パラメータ

communityId

型: String

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

q

型: String

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

archiveStatus

型: ConnectApi.GroupArchiveStatus

archiveStatus — グループがアーカイブ対象かどうかに基づいてグループのセットを指定します。

• All — アーカイブ対象かどうかに関係なく、すべてのグループ。
• Archived — アーカイブ対象のグループのみ。
• NotArchived — アーカイブ対象外のグループのみ。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

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

result

型: ConnectApi.Chatter​​​GroupPage

テスト ConnectApi.ChatterGroupPage オブジェクト。

戻り値

型: Void