Compartilhar via

mencionar tipo de recurso

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa uma notificação para uma pessoa com base no endereço de e-mail da pessoa. Este tipo de notificação também é conhecido como @menções.

O recurso de mensagem suporta menção. Inclui uma propriedade mentionsPreview que indica se o utilizador com sessão iniciada é mencionado nessa instância de mensagem. Também inclui a propriedade de navegação menções , que suporta a obtenção de detalhes de uma menção ou a eliminação de uma menção nessa instância.

Ao criar uma mensagem, uma aplicação pode criar uma menção no mesmo POST pedido ao incluir a menção na propriedade menções . Ao utilizar um GET pedido com o $filter parâmetro de consulta, uma aplicação pode devolver todas as mensagens na caixa de correio do utilizador com sessão iniciada que menciona o utilizador. Um GET pedido com o $expand parâmetro de consulta permite que a aplicação expanda todas as menções numa mensagem específica.

Este mecanismo de permitir que uma aplicação defina e receba menções em mensagens permite notificações leves, em que o utilizador que faz a menção pode permanecer no contexto existente (como compor um corpo de mensagem) enquanto a aplicação define a propriedade de menções subjacente. As pessoas mencionadas podem facilmente descobrir se e onde são mencionadas através GET de pedidos com o $filter parâmetro ou $expand consulta.

Por exemplo, no cliente de correio do Outlook, quando um utilizador escreve @ uma mensagem, o Outlook permite que o utilizador selecione ou introduza um nome para concluir a @menção. O Outlook define a propriedade de menções antes de criar e envia a mensagem ou evento. O Outlook também utiliza GET operações com $filter e $expand para permitir que o utilizador com sessão iniciada procure mensagens que mencionem o utilizador, alertando o utilizador para itens de ação ou debates, o que permite uma resposta mais rápida.

Métodos

Método Tipo de retorno Descrição
Publicar e enviar Nenhum Crie e envie menções como parte de uma nova mensagem.
Publicar num novo rascunho que contém um ou mais objetos de menção . Crie um rascunho de uma nova mensagem e inclua um ou mais objetos de menção .
Obter mensagens que me mencionam Coleção message Obtenha todas as mensagens na caixa de correio do utilizador com sessão iniciada que contêm uma menção a este utilizador.
Obter uma mensagem e as respetivas menções Coleção message Obtenha uma mensagem e expanda os detalhes de cada menção na mensagem.
Eliminar uma menção Nenhum Elimine a menção especificada na mensagem especificada na caixa de correio do utilizador com sessão iniciada.

Propriedades

Propriedade Tipo Descrição
aplicação Cadeia de caracteres O nome da aplicação onde a menção é criada. Opcional. Não utilizado e predefinido como nulo para a mensagem.
clientReference Cadeia de caracteres Um identificador exclusivo que representa um elemento principal da instância de recurso. Opcional. Não utilizado e predefinido como nulo para a mensagem.
createdBy emailAddress As informações de e-mail do utilizador que fez a menção.
createdDateTime DateTimeOffset A data e hora em que a menção é criada no cliente.
deepLink Cadeia de caracteres Uma ligação Web avançada para o contexto da menção na instância de recurso. Opcional. Não utilizado e predefinido como nulo para a mensagem.
id Cadeia de caracteres O identificador exclusivo de uma menção numa instância de recurso.
mencionado emailAddress As informações de e-mail da pessoa mencionada. Obrigatório.
mentionText String Opcional. Não utilizado e predefinido como nulo para a mensagem. Para obter as menções numa mensagem, consulte antes a propriedade bodyPreview da mensagem.
serverCreatedDateTime DateTimeOffset A data e hora em que a menção é criada no servidor. Opcional. Não utilizado e predefinido como nulo para a mensagem.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

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