Compartilhar via

MSGraphClientFactory class

  • Referência
Pacote:
@microsoft/sp-http-msgraph

Devolve uma versão pré-inicializada do MSGraphClient. Para obter mais informações: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph

Comentários

O construtor desta classe é marcado como interno. O código de terceiros não deve chamar diretamente o construtor ou criar subclasses que ampliem a classe MSGraphClientFactory.

Propriedades

serviceKey

A chave de serviço para MSGraphClientFactory.

Métodos

getClient(version)

Devolve uma instância da versão 3 do MSGraphClient V3 que comunica com o Principal de Serviço configurável do inquilino atual.
getClientWithMiddleware(version, options)

Devolve uma instância do MSGraphClient que comunica com o Pricipal de Serviço configurável do inquilino atual. Permite especificar opções de middleware personalizadas.

Detalhes da propriedade

serviceKey

A chave de serviço para MSGraphClientFactory.

static readonly serviceKey: ServiceKey<MSGraphClientFactory>;

Valor da propriedade

ServiceKey<MSGraphClientFactory>

Detalhes do método

getClient(version)

Devolve uma instância da versão 3 do MSGraphClient V3 que comunica com o Principal de Serviço configurável do inquilino atual.

getClient(version: '3'): Promise<MSGraphClientV3>;

Parâmetros

version

'3'

Retornos

Promise<MSGraphClientV3>

getClientWithMiddleware(version, options)

Devolve uma instância do MSGraphClient que comunica com o Pricipal de Serviço configurável do inquilino atual. Permite especificar opções de middleware personalizadas.

getClientWithMiddleware(version: '3', options: ClientOptions): Promise<MSGraphClientV3>;

Parâmetros

version

'3'

A versão do API do Graph a utilizar. 3.

options
@microsoft/microsoft-graph-client!ClientOptions:interface

Opções de cliente para o API do Graph.

Retornos

Promise<MSGraphClientV3>