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

名前空間: microsoft.graph

重要

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

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

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

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

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

たとえば、Outlook メール クライアントでは、ユーザーがメッセージの書き込み中に @ を入力すると、ユーザーは名前を選択または入力して @-メンションを完了できます。 Outlook では、メッセージまたはイベントを作成して送信する前に メンション プロパティを設定します。 Outlook では、$filterと$expandを使用した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"
}