AadHttpClient class

Pacote:

@microsoft/sp-http-base

O AadHttpClient é utilizado para efetuar chamadas REST numa Aplicação Azure AD.

Comentários

Esta classe está marcada como @sealed. As subclasses não devem expandi-la.

Para comunicar com o SharePoint, utilize a classe SPHttpClient . Para comunicar com o Microsoft Graph, utilize a classe MSGraphClient .

Construtores

(constructor)(serviceScope, resourceEndpoint, options)

Constrói uma nova instância da AadHttpClient classe

Propriedades

configurations

Os objetos AadHttpClientConfiguration predefinidos padrão para utilização com a classe AadHttpClient.

Métodos

fetch(url, configuration, options)	Executa uma chamada de serviço de REST.
get(url, configuration, options)	Chama fetch(), mas define o método como "GET".
post(url, configuration, options)	Chama fetch(), mas define o método como "POST".

Detalhes do construtor

(constructor)(serviceScope, resourceEndpoint, options)

Constrói uma nova instância da AadHttpClient classe

constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);

Parâmetros

serviceScope

ServiceScope

O âmbito do serviço é necessário para obter alguns dos componentes internos da classe.

resourceEndpoint

string

O recurso para o qual o token deve ser obtido.

options

IAadHttpClientOptions

Opções de configuração para o pedido para obter um token de acesso.

Detalhes da propriedade

configurations

Os objetos AadHttpClientConfiguration predefinidos padrão para utilização com a classe AadHttpClient.

static readonly configurations: IAadHttpClientConfigurations;

Valor da propriedade

IAadHttpClientConfigurations

Detalhes do método

fetch(url, configuration, options)

Executa uma chamada de serviço de REST.

fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;

Parâmetros

url

string

O URL do ponto final que a obtenção será chamado.

configuration

AadHttpClientConfiguration

Determina o comportamento predefinido de HttpClient; normalmente, este deve ser o número da versão mais recente de HttpClientConfigurations.

options

IHttpClientOptions

Opções adicionais que afetam o pedido.

Retornos

Promise<HttpClientResponse>

Uma promessa que devolverá o resultado.

Comentários

Embora a subclasse AadHttpClient adicione melhoramentos adicionais, os parâmetros e a semântica de HttpClient.fetch() são essencialmente os mesmos que o padrão da API WHATWG documentado aqui: https://fetch.spec.whatwg.org/

get(url, configuration, options)

Chama fetch(), mas define o método como "GET".

get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;

Parâmetros

url

string

O URL do ponto final que a obtenção será chamado.

configuration

AadHttpClientConfiguration

Determina o comportamento predefinido de HttpClient; normalmente, este deve ser o número da versão mais recente de HttpClientConfigurations.

options

IHttpClientOptions

Opções adicionais que afetam o pedido.

Retornos

Promise<HttpClientResponse>

Uma promessa que devolverá o resultado.

post(url, configuration, options)

Chama fetch(), mas define o método como "POST".

post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;

Parâmetros

url

string

O URL do ponto final que a obtenção será chamado.

configuration

AadHttpClientConfiguration

Determina o comportamento predefinido de HttpClient; normalmente, este deve ser o número da versão mais recente de HttpClientConfigurations.

options

IHttpClientOptions

Opções adicionais que afetam o pedido.

Retornos

Promise<HttpClientResponse>

Uma promessa que devolverá o resultado.