リソースの種類メンション

[アーティクル]
04/05/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ユーザーのメールアドレスに基づくユーザーへの通知を表します。この種類の通知は@-メンションとも呼ばれます。

メッセージリソースは、メンションをサポートします。これには、サインインしたユーザーがそのメッセージインスタンスにメンションされているかどうかを示す mentionsPreview プロパティが含まれています。また、メンション ナビゲーションプロパティも含まれています。このプロパティでは、メンションの詳細を取得したり、そのインスタンス内のメンションを削除したりできます。

メッセージを作成するときに、アプリは mentions プロパティにメンションを含めることで、同じPOST要求にメンションを作成できます。クエリパラメーターでGET要求を$filter使用すると、アプリはサインインしているユーザーのメールボックス内のすべてのメッセージを返し、ユーザーをメンションできます。 GETクエリパラメーターを$expand持つ要求を使用すると、アプリは特定のメッセージ内のすべてのメンションを展開できます。

アプリにメッセージの設定とメンションの取得を許可するこのメカニズムにより、軽量の通知が可能になります。これにより、メンションを作成するユーザーは、基になるメンション プロパティを設定しながら、既存のコンテキスト (メッセージ本文の作成など) に留めることができます。メンションされたユーザーは、または $expand クエリパラメーターを使用して要求を通じてGETメンションされるかどうかと場所を簡単に$filter確認できます。

たとえば、Outlook メールクライアントでは、ユーザーがメッセージの書き込み中に入力@すると、ユーザーは名前を選択または入力して@-メンションを完了できます。 Outlook では、メッセージまたはイベントを作成して送信する前に メンション プロパティを設定します。また、Outlook では、と $expand の$filter操作を使用GETして、サインインしているユーザーがユーザーにメンションするメッセージを検索し、ユーザーにアクションアイテムやディスカッションを通知して、より迅速な応答を可能にします。

メソッド

メソッド	戻り値の型	説明
投稿と送信	なし	メンションを作成し、新しいメッセージの一部として送信します。
新しい下書きに投稿する	1 つ以上のメンションオブジェクトを含むメッセージ。	新しいメッセージの下書きを作成し、1 つ以上のメンションオブジェクトを含めます。
自分に関するメッセージを取得する	message コレクション	サインインしているユーザーのメールボックスに、このユーザーのメンションを含むすべてのメッセージを取得します。
メッセージとそのメンションを取得する	message コレクション	メッセージを取得し、メッセージ内の各メンションの詳細を展開します。
メンションを削除する	なし	サインインしているユーザーのメールボックス内の指定したメッセージ内の指定したメンションを削除します。

プロパティ

プロパティ	型	説明
アプリケーション	String	メンションが作成されるアプリケーションの名前。省略可能です。メッセージには使用されず、既定値は null です。
clientReference	String	リソースインスタンスの親を表す一意の識別子。省略可能です。メッセージには使用されず、既定値は null です。
createdBy	emailAddress	メンションを作成したユーザーの電子メール情報。
createdDateTime	DateTimeOffset	クライアントでメンションが作成された日時。
deepLink	String	リソースインスタンス内のメンションのコンテキストへのディープ Web リンク。省略可能です。メッセージには使用されず、既定値は null です。
id	String	リソースインスタンス内のメンションの一意の識別子。
言及	emailAddress	指定したユーザーの電子メール情報。必須です。
mentionText	String	省略可能。メッセージには使用されず、既定値は null です。メッセージ内のメンションを取得するには、代わりにメッセージの bodyPreview プロパティを参照してください。
serverCreatedDateTime	DateTimeOffset	メンションがサーバー上に作成される日時。省略可能です。メッセージには使用されず、既定値は null です。

リレーションシップ

なし。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "application": "string",
  "clientReference": "string",
  "createdBy": {"@odata.type": "microsoft.graph.emailAddress"},
  "createdDateTime": "DateTimeOffset",
  "deepLink": "string",
  "id": "string (identifier)",
  "mentioned": {"@odata.type": "microsoft.graph.emailAddress"},
  "mentionText": "string",
  "serverCreatedDateTime": "DateTimeOffset"
}