Tipo de recurso openTypeExtension (extensões abertas)

Namespace: microsoft.graph

Representa extensões abertas (também conhecidas como extensões de tipo aberto e anteriormente conhecidas como extensões de dados do Office 365), uma opção de extensibilidade que fornece uma forma fácil de adicionar diretamente propriedades não digitadas a um recurso no Microsoft Graph.

Qualquer extensão aberta adicionada a um recurso é mostrada na propriedade de navegação extensões.. Cada extensão tem uma propriedade extensionName que é a única propriedade gravável predefinida para todas as extensões, juntamente com os seus dados personalizados. Um modo de garantir que os nomes de extensão sejam exclusivos é usar um formato reverso de DNS no sistema de nomes de domínio que dependa de seu próprio domínio, por exemplo, com.contoso.ContactInfo. Não utilize o domínio Microsoft (com.microsoft ou com.onmicrosoft) num nome de extensão.

Deriva do tipo abstrato de extensão.

Os seguintes recursos suportam a extensão aberta:

Nota: * Devido a uma limitação de serviço existente, os delegados não podem criar eventos abertos anexados por extensões em calendários de caixa de correio partilhados. As tentativas de fazer isso resultarão em uma resposta de ErrorAccessDenied.

Para obter mais informações sobre a extensibilidade do Microsoft Graph, incluindo limites para extensões abertas, consulte Adicionar propriedades personalizadas aos recursos usando extensões e Adicionar dados personalizados aos usuários usando extensões abertas.

Considerações específicas do Outlook

Cada extensão aberta num recurso do Outlook (evento, mensagem ou contacto pessoal) é armazenada numa propriedade com o nome MAPI. Quando você cria extensões abertas no Outlook, considere que as propriedades MAPI são um recurso finito em uma caixa de correio do usuário. Quando a quota de propriedades nomeada de um utilizador está esgotada, já não pode criar propriedades nomeadas para esse utilizador. Isso pode resultar em um comportamento inesperado de clientes que dependem de propriedades nomeadas para funcionar.

Aplique as seguintes diretrizes quando você criar extensões abertas em recursos do Outlook:

  • Crie um número mínimo de extensões necessárias. A maioria dos aplicativos exigem não mais que uma extensão. As extensões não têm propriedades ou estrutura definidas, pelo que pode armazenar múltiplos valores numa única extensão.
  • Evite renomear extensões de uma maneira variável (por exemplo, com base na entrada do usuário, etc.). Sempre que uma extensão aberta é criada com um novo nome que não foi utilizado na caixa de correio de um utilizador, é criada uma nova propriedade mapi chamada. Remover a extensão não remove a propriedade com nome.

Use extensões abertas (para recursos do Outlook) ou propriedades estendidas

Extensões abertas são a solução recomendada para a maioria dos cenários que envolvem armazenar e acessar dados personalizados. No entanto, se precisar de aceder a dados personalizados para propriedades MAPI do Outlook que ainda não estejam expostas através dos metadados da Microsoft Graph API, pode utilizar propriedades expandidas e a respetiva API REST. Você pode verificar quais propriedades os metadados expõem na https://graph.microsoft.com/v1.0/$metadata.

Métodos

Método Tipo de retorno Descrição
Criar openTypeExtension (numa instância de recurso existente) ou um novo todoTask, todoTaskListcontacto, evento, mensagem, post, todoTask ou todoTaskList que contém um objeto openTypeExtension. Crie um objeto openTypeExtension em uma instância de recurso nova ou existente.
Get openTypeExtension Leia propriedades e relações do objeto openTypeExtension.
Update openTypeExtension Atualize o objeto openTypeExtension.
Delete Nenhuma Exclua um objeto openTypeExtension.

Propriedades

Propriedade Tipo Descrição
extensionName String Um identificador de texto exclusivo para uma extensão de dados de tipo aberto. Opcional.
id String Um identificador totalmente qualificado que concatena o tipo de extensão com extensionName. Somente leitura.

O ID tem de ser definido durante a operação Criar através de uma das seguintes formas:
  • Defina explicitamente a propriedade ID no corpo do pedido.
  • Defina uma propriedade extensionName no corpo do pedido e o Microsoft Graph atribui automaticamente o mesmo valor à propriedade ID .
    • Nas atualizações subsequentes, pode alterar o valor da propriedade extensionName para um valor diferente do valor de ID .
    • Nas atualizações subsequentes, especificar apenas a propriedade ID no corpo do pedido elimina automaticamente a propriedade extensionName da extensão aberta.

Relações

Nenhum

Representação JSON

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

{
  "extensionName": "string",
  "id": "String (identifier)"
}