AadHttpClient class

Пакет:

@microsoft/sp-http-base

AadHttpClient используется для выполнения вызовов REST к приложению Azure AD.

Комментарии

Этот класс помечается как @sealed. Подклассы не должны расширять его.

Для взаимодействия с SharePoint используйте вместо него класс SPHttpClient . Для взаимодействия с Microsoft Graph используйте класс MSGraphClient .

Конструкторы

(constructor)(serviceScope, resourceEndpoint, options)

Создает новый экземпляр AadHttpClient класса

Свойства

configurations

Стандартные предопределенные объекты AadHttpClientConfiguration для использования с классом AadHttpClient.

Методы

fetch(url, configuration, options)	Выполняет вызов службы REST.
get(url, configuration, options)	Вызывает метод fetch(), но задает для метода значение GET.
post(url, configuration, options)	Вызывает метод fetch(), но задает для метода значение POST.

Сведения о конструкторе

(constructor)(serviceScope, resourceEndpoint, options)

Создает новый экземпляр AadHttpClient класса

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

Параметры

serviceScope

ServiceScope

Для получения некоторых внутренних компонентов класса требуется область службы.

resourceEndpoint

string

Ресурс, для которого должен быть получен маркер.

options

IAadHttpClientOptions

Параметры конфигурации для запроса на получение маркера доступа.

Сведения о свойстве

configurations

Стандартные предопределенные объекты AadHttpClientConfiguration для использования с классом AadHttpClient.

static readonly configurations: IAadHttpClientConfigurations;

Значение свойства

IAadHttpClientConfigurations

Сведения о методе

fetch(url, configuration, options)

Выполняет вызов службы REST.

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

Параметры

url

string

Будет вызван URL-адрес конечной точки, по которому будет использоваться выборка.

configuration

AadHttpClientConfiguration

Определяет поведение HttpClient по умолчанию; Обычно это должен быть номер последней версии из HttpClientConfigurations.

options

IHttpClientOptions

Дополнительные параметры, влияющие на запрос.

Возвращаемое значение

Promise<HttpClientResponse>

Обещание, которое вернет результат.

Комментарии

Хотя подкласс AadHttpClient добавляет дополнительные улучшения, параметры и семантика для HttpClient.fetch() по существу совпадают со стандартом API WHATWG, который описан здесь: https://fetch.spec.whatwg.org/

get(url, configuration, options)

Вызывает метод fetch(), но задает для метода значение GET.

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

Параметры

url

string

Будет вызван URL-адрес конечной точки, по которому будет использоваться выборка.

configuration

AadHttpClientConfiguration

Определяет поведение HttpClient по умолчанию; Обычно это должен быть номер последней версии из HttpClientConfigurations.

options

IHttpClientOptions

Дополнительные параметры, влияющие на запрос.

Возвращаемое значение

Promise<HttpClientResponse>

Обещание, которое вернет результат.

post(url, configuration, options)

Вызывает метод fetch(), но задает для метода значение POST.

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

Параметры

url

string

Будет вызван URL-адрес конечной точки, по которому будет использоваться выборка.

configuration

AadHttpClientConfiguration

Определяет поведение HttpClient по умолчанию; Обычно это должен быть номер последней версии из HttpClientConfigurations.

options

IHttpClientOptions

Дополнительные параметры, влияющие на запрос.

Возвращаемое значение

Promise<HttpClientResponse>

Обещание, которое вернет результат.