ChatterGroups クラス

getGroup(communityId, groupId)

グループに関する情報を取得します。

API バージョン

28.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

型: ConnectApi.ChatterGroupDetail

getGroupBatch(communityId, groupIds)

グループのリストに関する情報を取得します。

API バージョン

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupIds: 型: List<String>; 最大 500 件のグループ ID のリスト。

戻り値

型: ConnectApi.BatchResult[]

ConnectApi.BatchResult.getResult() メソッドは、読み込まれなかったグループの結果に含まれる ConnectApi.ChatterGroup オブジェクトとエラーを返します。

例

1// Create a list of groups.
2ConnectApi.ChatterGroupPage groupPage = ConnectApi.ChatterGroups.getGroups(null);
3
4// Create a list of group IDs.
5List<String> groupIds = new List<String>();
6for (ConnectApi.ChatterGroup aGroup : groupPage.groups){
7    groupIds.add(aGroup.id); 
8}
9
10// Get info about all the groups in the list.
11ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterGroups.getGroupBatch(null, groupIds);
12    
13for (ConnectApi.BatchResult batchResult : batchResults) {
14    if (batchResult.isSuccess()) {
15        // Operation was successful. 
16        // Print the number of members in each group.
17        ConnectApi.ChatterGroup aGroup;
18        if(batchResult.getResult() instanceof ConnectApi.ChatterGroup) {
19           aGroup = (ConnectApi.ChatterGroup) batchResult.getResult();
20        }
21        System.debug('SUCCESS');
22        System.debug(aGroup.memberCount);
23    }
24    else {
25        // Operation failed. Print errors.
26        System.debug('FAILURE');
27        System.debug(batchResult.getErrorMessage());
28    }
29}

getGroupMembershipRequest(communityId, requestId)

非公開グループへの参加要求に関する情報を取得します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
requestId: 型: String; 非公開グループへの参加要求の ID。

戻り値

使用方法

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

getGroupMembershipRequests(communityId, groupId)

非公開グループへのすべての参加要求に関する情報を取得します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

型: ConnectApi.GroupMembershipRequests

使用方法

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

getGroupMembershipRequests(communityId, groupId, status)

指定された状況の非公開グループへのすべての参加要求に関する情報を取得します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

groupId

型: String

グループの ID。

status

型: ConnectApi.GroupMembershipRequestStatus

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

Accepted
Declined
Pending

戻り値

型: ConnectApi.GroupMembershipRequests

使用方法

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

getGroups(communityId)

グループの最初のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupPage getGroups(String communityId)

パラメーター

communityId: 型: String; Experience Cloud サイト�� ID、internal、または null。

戻り値

getGroups(communityId, pageParam, pageSize)

グループのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getGroups(communityId, pageParam, pageSize, archiveStatus)

アーカイブ状況が指定されたグループのページを取得します。

API バージョン

29.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

pageParam

型: Integer

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

pageSize

型: Integer

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

archiveStatus

型: ConnectApi.GroupArchiveStatus

グループのアーカイブ状況。

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

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

戻り値

getMember(communityId, membershipId)

グループメンバーに関する情報の取得。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
membershipId: 型: String; メンバーシップの ID。

戻り値

型: ConnectApi.GroupMember

getMembers(communityId, groupId)

グループのメンバーに関する情報の最初のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

36.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

型: ConnectApi.GroupMemberPage

getMembers(communityId, groupId, pageParam, pageSize)

グループのメンバーに関する情報のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

36.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.GroupMemberPage

getMembershipBatch(communityId, membershipIds)

グループメンバーシップリストに関する情報を取得します。

API バージョン

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
membershipIds: 型: List<String>; 最大 500 件のグループメンバーシップ ID のリスト。

戻り値

型: ConnectApi.BatchResult[]

ConnectApi.BatchResult.getResult() メソッドは、読み��まれなかったグループの結果に含まれる ConnectApi.GroupMember オブジェクトとエラーを返します。

例

1// Get members of a group.
2ConnectApi.GroupMemberPage membersPage = ConnectApi.ChatterGroups.getMembers(null, '0F9D00000000oOT');
3
4// Create a list of membership IDs.
5List<String> membersList = new List<String>();
6for (ConnectApi.GroupMember groupMember : membersPage.members){
7    membersList.add(groupMember.id); 
8}
9
10// Get info about all group memberships in the list.
11ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterGroups.getMembershipBatch(null, membersList);
12
13for (ConnectApi.BatchResult batchResult : batchResults) {
14    if (batchResult.isSuccess()) {
15        // Operation was successful. 
16        // Print the first name of each member.
17        ConnectApi.GroupMember groupMember;
18        if(batchResult.getResult() instanceof ConnectApi.GroupMember) {
19            groupMember = (ConnectApi.GroupMember) batchResult.getResult();
20        }
21        System.debug('SUCCESS');
22        System.debug(groupMember.user.firstName);
23    }
24    else {
25        // Operation failed. Print errors.
26        System.debug('FAILURE');
27        System.debug(batchResult.getErrorMessage());
28    }
29}

getMyChatterSettings(communityId, groupId)

グループのコンテキストユーザーの Chatter 設定を取得します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

型: ConnectApi.GroupChatterSettings

getPhoto(communityId, groupId)

グループの写真を取得します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

型: ConnectApi.Photo

getRecord(communityId, groupRecordId)

グループに関連付けられたレコードを取得します。

API バージョン

34.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.GroupRecord getRecord(String communityId, String groupRecordId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupRecordId: 型: String; グループレコードの ID。

戻り値

型: ConnectApi.GroupRecord

getRecords(communityId, groupId)

グループに関連付けられたレコードの最初のページを取得します。

API バージョン

33.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

型: ConnectApi.GroupRecordPage

getRecords(communityId, groupId, pageParam, pageSize)

グループに関連付けられたレコードのページを取得します。

API バージョン

33.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.GroupRecordPage

inviteUsers(groupId, invite)

グループに参加してもらうために内部ユーザーおよび外部ユーザーを招待します。

API バージョン

39.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Invitations inviteUsers(String groupId, ConnectApi.InviteInput invite)

パラメーター

groupId: 型: String; グループの ID。
invite: 型: ConnectApi.InviteInput; ConnectApi.InviteInput 本文。

戻り値

型: ConnectApi.Invitations

postAnnouncement(communityId, groupId, announcement)

グループにお知らせを投稿します。

API バージョン

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
announcement: 型: ConnectApi.AnnouncementInput; ConnectApi.AnnouncementInput オブジェクト。

戻り値

型: ConnectApi.Announcement

使用方法

お知らせは、情報を強調表示するために使用します。ユーザーは、お知らせに対するディスカッション、いいね!、コメントの投稿ができます。フィード投稿を削除するとお知らせが削除されます。

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

removeRecord(communityId, groupRecordId)

レコードとグループの関連付けを削除します。

API バージョン

34.0

Chatter が必要かどうか

はい

署名

public static Void removeRecord(String communityId, String groupRecordId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupRecordId: 型: String; グループレコードの ID。

戻り値

型: Void

requestGroupMembership(communityId, groupId)

非公開グループのメンバーシップを要求します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。

戻り値

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

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

1String communityId = null;
2ID groupId = '0F9x00000000hAZ';
3
4ConnectApi.GroupMembershipRequest membershipRequest = ConnectApi.ChatterGroups.requestGroupMembership(communityId, groupId);

searchGroups(communityId, q)

検索条件に一致するグループの最初のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。null を指定できます。

戻り値

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。

searchGroups(communityId, q, pageParam, pageSize)

検索条件に一致するグループのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。null を指定できます。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。

searchGroups(communityId, q, archiveStatus, pageParam, pageSize)

検索条件に一致する、アーカイブ状況が指定されたグループのページを取得します。

API バージョン

29.0

ゲストユーザーが使用可能

31.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

q

型: String

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

archiveStatus

型: ConnectApi.GroupArchiveStatus

グループのアーカイブ状況。

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

pageParam

型: Integer

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

pageSize

型: Integer

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

戻り値

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。

setBannerPhoto(communityId, groupId, fileId, versionNumber)

アップロードされたファイルをグループのバナー写真として設定します。

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BannerPhoto setBannerPhoto(String communityId, String groupId, String fileId, Integer versionNumber)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
fileId: 型: String; すでにアップロー��されたファイルの ID。キープレフィックスは 069、画像は 8 MB 未満にする必要があります。
versionNumber: 型: Integer; 既存ファイルのバージョン番号。既存のバージョン番号を指定するか、null を指定して最新バージョンを取得します。

戻り値

使用方法

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

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

setBannerPhoto(communityId, groupId, fileUpload)

アップロードされていないファイルをグループのバナー写真として設定します。

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BannerPhoto setBannerPhoto(String communityId, String groupId, ConnectApi.BinaryInput fileUpload)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
fileUpload: 型: ConnectApi.BinaryInput; 写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

使用方法

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

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

setBannerPhotoWithAttributes(communityId, groupId, bannerPhoto)

アップロードされたファイルをグループのバナー写真として設定してトリミングします。

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BannerPhoto setBannerPhotoWithAttributes(String communityId, String groupId, ConnectApi.BannerPhotoInput bannerPhoto)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
bannerPhoto: 型: ConnectApi.BannerPhotoInput; ファイルの ID とバージョン、およびファイルのトリミング方法を指定する ConnectApi.BannerPhotoInput オブジェクト。

戻り値

使用方法

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

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

setBannerPhotoWithAttributes(communityId, groupId, bannerPhoto, fileUpload)

アップロードされていないファイルをグループのバナー写真として設定してトリミングします。

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BannerPhoto setBannerPhotoWithAttributes(String communityId, String groupId, ConnectApi.BannerPhotoInput bannerPhoto, ConnectApi.BinaryInput fileUpload)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
bannerPhoto: 型: ConnectApi.BannerPhotoInput; トリミングパラメーターを指定する ConnectApi.BannerPhotoInput オブジェクト。
fileUpload: 型: ConnectApi.BinaryInput; 写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.GroupEmailFrequency

使用方法

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

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

setPhoto(communityId, groupId, fileId, versionNumber)

アップロードされたファイルをグループの写真として設定します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
fileId: 型: String; すでにアップロードされたファイルの ID。キープレフィックスは 069、ファイルは 2 GB 未満の画像にする必要があります。
versionNumber: 型: Integer; 既存ファイルのバージョン番号。既存のバージョン番号を指定するか、null を指定して最新バージョンを取得します。

戻り値

型: ConnectApi.Photo

使用方法

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

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

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

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

1String communityId = null;
2ID groupId = '0F9x00000000hAK';
3ID fileId = '069x00000001Ion';
4
5// Set photo
6ConnectApi.Photo photo = ConnectApi.ChatterGroups.setPhoto(communityId, groupId, fileId, null);

setPhoto(communityId, groupId, fileUpload)

アップロードされていないファイルをグループの写真として設定します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
fileUpload: 型: ConnectApi.BinaryInput; 写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.Photo

使用方法

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

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

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

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

1String communityId = null;
2ID groupId = '0F9x00000000hAP';
3ID photoId = '069x00000001Ioo';
4
5// Set photo
6List<ContentVersion> groupPhoto = [Select c.VersionData From ContentVersion c where ContentDocumentId=:photoId];
7ConnectApi.BinaryInput binary = new ConnectApi.BinaryInput(groupPhoto.get(0).VersionData, 'image/png', 'image.png');
8ConnectApi.Photo photo = ConnectApi.ChatterGroups.setPhoto(communityId, groupId, binary);

setPhotoWithAttributes(communityId, groupId, photo)

アップロードされたファイルをグループの写真として設定してトリミングします。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
photo: 型: ConnectApi.PhotoInput; ファイルの ID とバージョン、およびファイルのトリミング方法を指定する ConnectApi.PhotoInput オブジェクト。

戻り値

型: ConnectApi.Photo

使用方法

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

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

setPhotoWithAttributes(communityId, groupId, photo, fileUpload)

アップロードされていないファイルをグループの写真として設定してトリミングします。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
photo: 型: ConnectApi.PhotoInput; fileUpload で指定されたファイルのトリミング方法を指定する ConnectApi.PhotoInput オブジェクト。
fileUpload: 型: ConnectApi.BinaryInput; 写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.Photo

使用方法

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

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

updateGroup(communityId, groupId, groupInput)

グループの設定を更新します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
groupId: 型: String; グループの ID。
groupInput: 型: ConnectApi.ChatterGroupInput; ConnectApi.ChatterGroupInput オブジェクト。

戻り値

型: ConnectApi.ChatterGroup

使用方法

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

例

この例では、グループをアーカイブします。

1String groupId = '0F9D00000000qSz';
2String communityId = null;
3
4ConnectApi.ChatterGroupInput groupInput = new ConnectApi.ChatterGroupInput();
5groupInput.isArchived = true;
6
7ConnectApi.ChatterGroups.updateGroup(communityId, groupId, groupInput);

updateGroupMember(communityId, membershipId, role)

グループメンバーのロールを更新します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

membershipId

型: String

メンバーシップの ID。

role

型: ConnectApi.GroupMembershipType

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

GroupManager
StandardMember

戻り値

型: ConnectApi.ChatterGroup

使用方法

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

updateMyChatterSettings(communityId, groupId, emailFrequency)

グループのコンテキストユーザーのメール頻度を更新します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

groupId

型: String

グループの ID。

emailFrequency

ユーザーがメールを受信する頻度。

EachPost
DailyDigest
WeeklyDigest
Never
UseDefault

値 UseDefault には、updateChatterSettings(communityId, userId, defaultGroupEmailFrequency) へのコールで設定された値が使用されます。

戻り値

型: ConnectApi.GroupChatterSettings

updateRequestStatus(communityId, requestId, status)

非公開グループへの参加要求を更新します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

requestId

型: String

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

status

型: ConnectApi.GroupMembershipRequestStatus

要求の状況:

Accepted
Declined

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

戻り値

使用方法

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

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

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

1String communityId = null;
2ID groupId = '0F9x00000000hAZ';
3String requestId = '0I5x000000001snCAA';
4
5ConnectApi.GroupMembershipRequest membershipRequestRep = ConnectApi.ChatterGroups.updateRequestStatus(communityId, requestId, 
6ConnectApi.GroupMembershipRequestStatus.Accepted);

updateRequestStatus(communityId, requestId, status, responseMessage)

非公開グループへの参加要求を更新し、必要に応じて要求が拒否された場合のメッセージを指定します。

API バージョン

35.0

Chatter が必要かどうか

はい

署名

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

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

requestId

型: String

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

status

型: ConnectApi.GroupMembershipRequestStatus

要求の状況:

Accepted
Declined

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

responseMessage

型: String

メンバーシップ要求が却下された場合にユーザーに表示するメッセージを指定します。このプロパティの値は、status プロパティの値が Declined の場合にのみ使用されます。

最大文字数は 756 文字です。

戻り値