直接またはグループを通じて行う Chatter への参加招待を表します。このオブジェクトは、API バージョン 21.0 以降で使用できます。
サポートされているコール
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
- 説明
- 招待の状況。可能な値は次のとおりです。
|
使用方法
このオブジェクトを使用して、Chatter の参加招待を作成または削除 (キャンセル) します。Chatter への直接の参加または CollaborationGroup のメンバーとしての参加のいずれかを招待できます。
CollaborationGroup に誰かを招待するには、グループの所有者かマネージャ、または Salesforce システム管理者である必要があります。
Salesforce システム管理者は、API を使って招待を送信するためにグループのメンバーである必要はありません。
CollaborationGroup 招待を承諾すると、そのユーザは CollaborationGroup および Chatter にも参加します。
招待は、招待の送信元の組織のユーザには送信できません。
招待されたユーザは、プロファイルを表示したり、フィードに投稿したり、グループに参加したりすることができます。ただし、Salesforce のデータまたはレコードを表示することはできません。
組織が顧客を含むグループを許可している場合、「顧客を許可」が設定された非公開グループの所有者とマネージャ、およびシステム管理者はこのオブジェクトを使用して、顧客を招待できます。
Java のサンプル
次の例では、Chatter に参加する招待の送信方法を示します。
次の例では、顧客を許可しているグループから顧客ユーザに招待を送信する方法を示します。
j