mention リソースの種類

名前空間: microsoft.graph

重要

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

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

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

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

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

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

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"
}

プロパティ

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

リレーションシップ

なし

メソッド

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