Compartilhar via


Componente de seletor no Microsoft Graph Toolkit

Cuidado

O Toolkit do Microsoft Graph foi preterido. O período de reforma começa a 1 de setembro de 2025, com a reforma completa prevista para 28 de agosto de 2026. Os programadores devem migrar para utilizar os SDKs do Microsoft Graph ou outras ferramentas suportadas do Microsoft Graph para criar experiências Web. Para obter mais informações, veja o anúncio de preterição.

O componente Seletor utiliza mgt-get para consultar o microsoft API do Graph e, em seguida, compõe um controlo de lista pendente que permite a seleção de um único recurso a partir de uma matriz de recursos.

Exemplo

O exemplo seguinte mostra a utilização do mgt-picker componente para selecionar uma lista de tarefas a partir das listas de tarefas de um utilizador. Pode utilizar o editor de código para ver como as propriedades e os atributos alteram o comportamento do componente.

Propriedades e atributos

Pode utilizar vários atributos para alterar o comportamento do componente. O componente tem atributos necessários, tais como resource , por exemplo, /users e key-name , por exemplo, displayName.

key-name também suporta valores aninhados. Por exemplo, na seguinte resposta:

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#applications/$entity",
    "id": "03ef14b0-ca33-4840-8f4f-d6e91916010e",
    "verifiedPublisher": {
            "displayName": "publisher_contoso",
            "verifiedPublisherId": "9999999",
             "addedDateTime": "2021-04-24T17:49:44Z"
    },
    "certification": {
           "isPublisherAttested": true,
           "isCertifiedByMicrosoft": true,
           "lastCertificationDateTime": "2021-05-11T23:26:20Z",
           "certificationExpirationDateTime": "2022-05-11T23:26:20Z",
           "certificationDetailsUrl": "https://v4.hkg1.meaqua.org/microsoft-365-app-certification/forward/azure/631a96bc-a705-4eda-9f99-fdaf9f54f6a2"
    },
    "tags": [],
    "tokenEncryptionKeyId": null,
    "api": {
        "requestedAccessTokenVersion": 2,
        "acceptMappedClaims": null,
        "knownClientApplications": [],
        "oauth2PermissionScopes": [],
        "preAuthorizedApplications": []
    },
    "appRoles": [],
    "web": {
        "redirectUris": [],
        "homePageUrl": null,
        "logoutUrl": null,
        "implicitGrantSettings": {
            "enableIdTokenIssuance": false,
            "enableAccessTokenIssuance": false
        }
    }
}

o valor do key-name atributo pode ser web.homePageUrl ou verifiedPublisher.displayName.

Atributo Propriedade Descrição
recurso recurso O recurso a obter do Microsoft Graph (por exemplo, /me ou /users).
marcador de posição marcador de posição O marcador de posição composto no seletor (por exemplo, Select a user ou Select a task list).
key-name keyName A chave a ser composta no seletor (por exemplo, displayName).
selected-value selectedValue Opcional. O valor a ser definido como a opção atualmente selecionada no seletor. Tem de estar presente nas opções fornecidas pela consulta do Microsoft Graph.
escopos escopos Matriz opcional de cadeias se utilizar a propriedade ou um âmbito delimitado por vírgulas se utilizar o atributo . O componente e um fornecedor suportado garantem que o utilizador deu consentimento a, pelo menos, uma das permissões fornecidas.
versão versão Versão opcional da API a utilizar ao fazer o GET pedido. O padrão é v1.0.
max-pages maxPages Número opcional de páginas (para recursos que suportam paginação). A predefinição é 3. Definir este valor como 0 obtém todas as páginas.
com cache ativada cacheEnabled Booleano opcional. Quando definido, indica que a resposta do recurso é colocada em cache. Substitua se refresh() for chamado ou se pollingRate estiver a ser utilizado. O padrão é false.
cache-invalidation-period cacheInvalidationPeriod Número opcional de milissegundos. Quando definido em combinação com cacheEnabled, o atraso antes de a cache atingir o respetivo período de invalidação modifica este valor. A predefinição é 0 e utiliza o período de invalidação predefinido.
N/D response Resposta só de leitura do Microsoft Graph se o pedido tiver sido efetuado com êxito.
N/D erro Erro só de leitura do Microsoft Graph se o pedido não tiver sido bem-sucedido.

Propriedades personalizadas do CSS

O mgt-picker componente define as seguintes propriedades personalizadas do CSS para fornecer substituições.

<mgt-picker
  class="picker"
  resource="me/todo/lists"
  scopes="tasks.read, tasks.readwrite"
  key-name="displayName"
></mgt-picker>
.picker {
  --picker-background-color: grey;
  --picker-list-max-height: 200px;
}

Para saber mais, veja Componentes de estilo.

Métodos

Método Descrição
refresh(force?: booleano) Chame o método para atualizar os dados. Por predefinição, a IU só é atualizada se os dados forem alterados. Passe true para forçar a atualização do componente.

Eventos

Evento Quando é emitido Dados personalizados Cancelável Bolhas Funciona com um modelo personalizado
selectionChanged Acionado quando existe uma alteração no recurso selecionado na lista pendente. { response: any, error: any }. A response propriedade contém a resposta obtida do Microsoft Graph. A error propriedade contém informações sobre o erro, caso tenha ocorrido um Não Sim Sim

Dica

Para obter mais informações sobre os dados devolvidos na response propriedade, veja a referência da API da API que utilizou na resource propriedade do componente Picker.

Para obter mais informações sobre o processamento de eventos, veja eventos.

Modelos

O mgt-picker componente suporta vários modelos que pode utilizar para definir o aspeto e funcionalidade. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina como data-type um dos seguintes valores.

Tipo de dados Contexto de dados Descrição
erro O erro do Microsoft Graph. Este modelo é utilizado se ocorrer um erro ao fazer o pedido.
a carregar N/D Este modelo é utilizado enquanto o pedido está a ser feito.
sem dados N/D Este modelo é utilizado quando o pedido não devolveu dados.

Utilização de modelos de exemplo

<mgt-picker resource="me/todo/lists" scopes="tasks.read, tasks.readwrite" key-name="displayName">
  <div>Loading template</div>
    <template data-type="loading">
      Loading
    </template>
    <template data-type="no-data">
      <div>No data</div>
    </template>
    <template data-type="error">
      <div>Error</div>
    </template>
  </div>
</mgt-picker>

Permissões do Microsoft Graph

As permissões exigidas por este componente dependem dos dados que pretende obter com o mesmo a partir do Microsoft Graph. O Microsoft Graph Toolkit verifica se o utilizador atual deu consentimento a, pelo menos, um dos fornecidos scopes. Para obter mais informações sobre permissões, consulte a referência de permissões do Microsoft Graph.

Autenticação

O controlo utiliza o fornecedor de autenticação global descrito na documentação de autenticação para obter os dados necessários.

Cache

Para ativar e configurar a cache, utilize as cacheEnabled propriedades e cacheInvalidationPeriod . Por predefinição, o mgt-picker componente não coloca em cache quaisquer respostas.

Arquivo de objetos Dados em cache Comentários
response Resposta completa obtida do Microsoft Graph para a consulta especificada na resource propriedade de mgt-picker

Para obter mais informações, veja Colocação em cache.

Localização

O controlo expõe as seguintes variáveis que podem ser localizadas. Para obter detalhes sobre como configurar a localização, veja Localizar componentes.

Nome da cadeia Valor padrão
comboboxPlaceholder Select an item