言及リソースの種類mention resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported.

個人の電子メールアドレスに基づいて、ユーザーへの通知を表します。Represents a notification to a person based on the person's email address. この種類の通知は、@ メンションとも呼ばれます。This type of notification is also known as @-mentions.

メッセージリソースは、メンションをサポートしています。The message resource supports mention. このプロパティには、サインインしているユーザーがそのメッセージインスタンスで言及されているかどうかを示すmentionsPreviewプロパティが含まれています。It includes a mentionsPreview property that indicates whether the signed-in user is mentioned in that message instance. また、メンションナビゲーションプロパティも含まれています。これは、メンションの詳細を取得するか、そのインスタンス内のメンションを削除することをサポートします。It also includes the mentions navigation property, which supports getting details of a mention, or deleting a mention in that instance.

アプリケーションでは、メッセージを作成するときに、メンションプロパティPOSTにメンションを含めることによって、同じ要求でメンションを作成できます。When creating a message, an app can create a mention in the same POST request by including the mention in the mentions property. クエリパラメーター GETを指定して要求を使用すると、アプリはサインインしているユーザーのメールボックス内のすべてのメッセージを返し、そのユーザーに言及できます。 $filterUsing a GET request with the $filter query parameter, an app can return all the messages in the signed-in user's mailbox that mention the user. クエリパラメーターを使用して要求するGETと、特定のメッセージ内のすべてのメンションを展開できます。 $expandA GET request with the $expand query parameter lets the app expand all mentions in a specific message.

メッセージでメンションを指定してメンションを取得するためのこのメカニズムにより、説明を作成しているユーザーが既存のコンテキスト (メッセージ本文の作成など) を既存のコンテキスト**** 内に残すことができます。.This mechanism of letting an app set and get mentions in messages enables lightweight notifications, where the user making the mention can remain in the existing context (such as composing a message body) while the app sets the underlying mentions property. 指定された人物は、 GET $filterまたは$expandクエリパラメーターを使用して、要求によってどこにあるか、どこにあるかを簡単に確認できます。Mentioned persons can easily find out if and where they are mentioned through GET requests with the $filter or $expand query parameter.

たとえば、Outlook メールクライアントでは、ユーザーがメッセージの作成@中に入力すると、ユーザーは名前を選択または入力して、@ メンションを完了できます。For example, in the Outlook mail client, when a user types @ while writing a message, Outlook lets the user select or enter a name to complete the @-mention. Outlook は、メッセージまたはイベントを作成して送信する前に、メンションプロパティを設定します。Outlook sets the mentions property before it creates and sends the message or event. Outlook でGET $filterは、および$expandを使用して、サインインしているユーザーに、ユーザーに通知するメッセージを検索させ、処理アイテムまたはディスカッションについての警告を表示して、応答を高速化することもできます。Outlook also uses GET operations with $filter and $expand to let the signed-in user look up messages that mention the user, alerting the user to action items or discussions, which allows for a faster response.

JSON 表記JSON representation

以下は、リソースの JSON 表記です。Here is a JSON representation of the resource.

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

プロパティProperties

プロパティProperty Type 説明Description
applicationapplication StringString メンションが作成されたアプリケーションの名前。The name of the application where the mention is created. 省略可能。Optional. 使用されず、メッセージの既定値として null になります。Not used and defaulted as null for message.
clientReferenceclientReference StringString リソースインスタンスの親を表す一意の識別子。A unique identifier that represents a parent of the resource instance. 省略可能。Optional. 使用されず、メッセージの既定値として null になります。Not used and defaulted as null for message.
createdBycreatedBy emailAddressemailAddress メンションを行ったユーザーの電子メール情報。The email information of the user who made the mention.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset クライアントでメンションが作成された日時。The date and time that the mention is created on the client.
リンクdeepLink StringString リソースインスタンス内のメンションのコンテキストへのディープ web リンク。A deep web link to the context of the mention in the resource instance. 省略可能。Optional. 使用されず、メッセージの既定値として null になります。Not used and defaulted as null for message.
idid StringString リソース インスタンス内のメンションの一意の識別子。The unique identifier of a mention in a resource instance.
明記mentioned emailAddressemailAddress 記載されているユーザーの電子メール情報。The email information of the mentioned person. 必須です。Required.
mentionTextmentionText StringString 省略可能。Optional. 使用されず、メッセージの既定値として null になります。Not used and defaulted as null for message. メッセージ内のメンションを取得するには、代わりにメッセージのbodyPreviewプロパティを参照してください。To get the mentions in a message, see the bodyPreview property of the message instead.
Serverん DatetimeserverCreatedDateTime DateTimeOffsetDateTimeOffset メンションがサーバー上に作成された日付と時刻。The date and time that the mention is created on the server. 省略可能。Optional. 使用されず、メッセージの既定値として null になります。Not used and defaulted as null for message.

リレーションシップRelationships

なしNone

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
投稿と送信Post and send NoneNone 新しいメッセージの一部としてメンションを作成して送信します。Create and send mentions as part of a new message.
新しい下書きに投稿するPost to a new draft 1つまたは複数のメンションオブジェクトを含むメッセージmessage that contains one or more mention objects. 新しいメッセージの下書きを作成し、1つまたは複数のメンションオブジェクトを含めます。Create a draft of a new message and include one or more mention objects.
自分宛てのメッセージを取得するGet messages mentioning me message コレクションmessage collection このユーザーのメンションを含む、サインインしているユーザーのメールボックス内のすべてのメッセージを取得します。Get all the messages in the signed-in user's mailbox that contain a mention of this user.
メッセージとそのメンションを取得するGet a message and its mentions message コレクションmessage collection メッセージを取得して、メッセージ内の各メンションの詳細を展開します。Get a message and expand the details of each mention in the message.
メンションを削除するDelete a mention NoneNone サインインしているユーザーのメールボックス内で指定したメッセージにおいて、指定したメンションを削除します。Deletes the specified mention in the specified message in the signed-in user's mailbox.