CollaborationInvitation | Salesforce および Force.com のオブジェクトリファレンス

サポートされているコール

create()、delete()、describeSObjects()、query()、retrieve()

特別なアクセスルール

招待は、組織で「招待を許可」が有効になっている場合に利用可能です。

招待は、顧客を許可している非公開グループから送信された場合を除き、許可済みドメインに制限されます。許可済みドメインは、管理者が設定します。

顧客への招待は、組織で「顧客の招待を許可」が有効になっている場合に利用可能です。Chatter ドメイン外の人に招待を送信するユーザは、「Chatter に顧客を招待する」権限が必要です。

項目

項目	詳細
InvitedUserEmail	型 string プロパティ Create、Filter、Group、Sort 説明 Chatter へ参加招待したユーザのメールアドレス。表示ラベルは [被招集メール] です。
InvitedUserEmailNormalized	型 email プロパティ Filter、Group、Sort 説明入力された InvitedUserEmail の正規化バージョン。表示ラベルは [被招集メール (標準化)] です。
InviterId	型 reference プロパティ Filter、Group、Sort 説明招待を行ったユーザ。
OptionalMessage	型 string プロパティ Create、Filter、Group、Nillable、Sort 説明招待を受け取るユーザに招待を送信するユーザからの省略可能なメッセージ。
ParentId	型 reference プロパティ Filter、Group、Nillable、Sort 説明招待者が招待を受け入れる場合、招待状のメールアドレスが入力されたメールアドレスと異なる場合に使用します。
SharedEntityId	型 reference プロパティ Create、Filter、Group、Sort 説明この招待に関連付けられたユーザまたはグループの ID。 Chatter に参加するための招待である場合、SharedEntityId は招待を作��した User の ID です。招待者は招待主を自動的にフォローします。 Chatter 内のグループに参加するための招待である場合、SharedEntityId は Chatter CollaborationGroup の ID です。顧客を招待するには、SharedEntityId を Customers の許可が設定されている非公開の CollaborationGroup の ID に設定します。
Status	型 picklist プロパティ Filter、Group、Restricted picklist、Sort 説明招待の状況。値は次のとおりです。 `Sent` `Accepted` `Canceled`

使用方法

このオブジェクトを使用して、Chatter の参加招待を作成または削除 (キャンセル) します。Chatter への直接の参加または CollaborationGroup のメンバーとしての参加のいずれかを招待できます。

CollaborationGroup に誰かを招待するには、グループの所有者かマネージャ、または Salesforce システム管理者である必要があります。

Salesforce システム管理者は、API を使って招待を送信するためにグループのメンバーである必要はありません。

メモ

CollaborationGroup 招待を承諾すると、そのユーザは CollaborationGroup および Chatter にも参加します。

招待は、招待の送信元の組織のユーザには送信できません。

メモ

招待されたユーザは、プロファイルを表示したり、フィードに投稿したり、グループに参加したりすることができますが、Salesforce のデータまたはレコードを表示することはできません。

組織が顧客を含むグループを許可している場合、「顧客を許可」が設定された非公開グループの所有者とマネージャ、およびシステム管理者はこのオブジェクトを使用して、顧客を招待できます。

Java のサンプル

次の例では、Chatter に参加する招待の送信方法を示します。

1public void invitePeople(String inviterUserId, String invitedEmail) throws Exception {
2    CollaborationInvitation invitation = new CollaborationInvitation();
3    invitation.setSharedEntityId(inviterUserId);//pass the userId of the inviter
4    invitation.setInvitedUserEmail(invitedEmail);//email of the invited user
5    insert(invitation);
6}

次の例では、顧客を許可しているグループから顧客ユーザに招待を送信する方法を示します。

1public void inviteToGroup(String GroupName, String invitedEmail) throws Exception {
2    QueryResult qr = query("select id from collaborationgroup where name = '" + 
3        GroupName); //pass the group name
4    String groupId = qr.getRecords()[0].getId();
5    CollaborationInvitation invitation = new CollaborationInvitation();
6    invitation.setSharedEntityId(groupId);//pass the groupId
7    invitation.setInvitedUserEmail(invitedEmail);//email of the invited user
8    insert(invitation);
9}

Apex のサンプル

1String emailAddress = 'bob@external.com';
2CollaborationGroup chatterGroup = [SELECT Id 
3      FROM CollaborationGroup 
4      WHERE Name='All acme.com' 
5      LIMIT 1];
6CollaborationInvitation inv = New CollaborationInvitation();
7inv.SharedEntityId = chatterGroup.id;
8inv.InvitedUserEmail = emailAddress;
9
10try {
11   Insert inv;
12} catch(DMLException e){
13   System.debug('There was an error with the invite: '+e);
14}