Tipo de recurso openTypeExtension (extensões abertas)

  • Artigo

Namespace: microsoft.graph

Representa extensões abertas (também conhecidas como extensões de tipo aberto e anteriormente conhecidas como extensões de dados Office 365), uma opção de extensibilidade que fornece uma maneira fácil de adicionar diretamente propriedades não tipados 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 pré-definida e gravável para todas as extensões, juntamente com 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 use o domínio da Microsoft (com.microsoft ou com.onmicrosoft) em um nome de extensão.

Deriva do tipo abstrato de extensão.

As extensões abertas são compatíveis com os recursos a seguir.

Observação: * Devido a uma limitação de serviço existente, os delegados não podem criar eventos abertos acrescentados por extensão em calendários de caixas de correio compartilhadas. 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 presente em um recurso do Outlook (evento, mensagem ou contato pessoal) é armazenada em uma propriedade 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 cota de propriedade nomeada de um usuário é esgotada, você não pode criar mais propriedades nomeadas para esse usuário. 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 um conjunto definido de propriedades nomeadas ou estrutura, para que seja possível armazenar vários valores em um ú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 usado na caixa de correio de um usuário antes, uma nova propriedade nomeada MAPI é criada. A remoção da extensão não remove a propriedade nomeada.

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 você precisar acessar dados personalizados para propriedades MAPI do Outlook que ainda não foram expostas por meio dos metadados do Microsoft API do Graph, você poderá usar propriedades estendidas e sua 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 (em uma instância de recurso existente), ou um novo todoTask, todoTaskList, contato, evento, mensagem, ou postagemt, todoTask ou todoTaskListque 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.

A id deve ser definida durante a operação Criar por meio de uma das seguintes maneiras:
  • Defina explicitamente a propriedade id no corpo da solicitação.
  • Defina uma propriedade extensionName no corpo da solicitação e o Microsoft Graph atribui automaticamente o mesmo valor à propriedade id .
    • Em atualizações subsequentes, você pode alterar o valor da propriedade extensionName para um diferente do valor da id .
    • Nas atualizações subsequentes, especificar apenas a propriedade id no corpo da solicitação exclui automaticamente a propriedade extensionName da extensão aberta.

Relações

Nenhum

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

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

Conteúdo relacionado