SPHttpClientConfiguration class
Конфигурация для SPHttpClient.
- Extends
Комментарии
Объект SPHttpClientConfiguration предоставляет набор параметров для включения или выключения различных возможностей класса SPHttpClient. Обычно эти параметры задаются (например, при вызове SPHttpClient.fetch()) путем предоставления одного из предопределенных значений по умолчанию из SPHttpClientConfigurations, но эти параметры можно также изменять с помощью метода SPHttpClientConfiguration.overrideWith().
Конструкторы
| (constructor)(flags, override |
Создает новый экземпляр SPHttpClientConfiguration с помощью указанных флажков. Значения по умолчанию будут использоваться для любых отсутствующих или неопределенных флажков. Если указан overrideFlags, он переопределяет флажки. |
Свойства
| default |
Автоматически настройте заголовок "OData-Version". |
| default |
Автоматическая настройка RequestInit.credentials. |
| flags | |
| request |
Автоматически укажите заголовок "X-RequestDigest" для проверки подлинности. |
| use |
Обработка обновления файлов cookie с помощью всплывающего диалогового окна |
Сведения о конструкторе
(constructor)(flags, overrideFlags)
Создает новый экземпляр SPHttpClientConfiguration с помощью указанных флажков. Значения по умолчанию будут использоваться для любых отсутствующих или неопределенных флажков. Если указан overrideFlags, он переопределяет флажки.
constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);Параметры
- overrideFlags
- ISPHttpClientConfiguration
Сведения о свойстве
defaultODataVersion
Автоматически настройте заголовок "OData-Version".
get defaultODataVersion(): ODataVersion;Значение свойства
Комментарии
Если этот параметр указан (т. е. не определен): если заголовок "OData-Version" не был явно добавлен для запроса, SPHttpClient добавит заголовок, чтобы указать версию, указанную defaultODataVersion.
ПРИМЕЧАНИЕ. В большинстве случаев без заголовка OData-Version сервер SharePoint по умолчанию использует версию 3.0. Рекомендуемая версия — 4.0.
defaultSameOriginCredentials
Автоматическая настройка RequestInit.credentials.
get defaultSameOriginCredentials(): boolean;Значение свойства
boolean
Комментарии
Если этот параметр имеет значение true, выполните следующее:
Если параметр RequestInit.credentials явно не указан для запроса, spHttpClient присвоит ему значение "same-origin". Без этого параметра разные веб-браузеры могут применять разные значения по умолчанию.
Дополнительные сведения см. в спецификации: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials
flags
requestDigest
Автоматически укажите заголовок "X-RequestDigest" для проверки подлинности.
get requestDigest(): boolean;Значение свойства
boolean
Комментарии
Если этот параметр имеет значение true, выполните следующее:
Если заголовок "X-RequestDigest" явно не был добавлен для запроса, spHttpClient добавит его, если запрос является операцией записи (т. е. методОМ HTTP, отличным от "GET", "HEAD" или "OPTIONS"). Дайджест запроса управляется службой DigestCache. В случае промаха кэша может быть выполнен дополнительный сетевой запрос.
usePopupForCookieRefresh
Обработка обновления файлов cookie с помощью всплывающего диалогового окна
get usePopupForCookieRefresh(): boolean;Значение свойства
boolean
Комментарии
Если этот параметр имеет значение true, для обработки обновления файлов cookie будет использоваться проверка подлинности всплывающего окна. Это означает, что вызывающий объект должен обрабатывать события всплывающих окон. Если он не определен или false, по умолчанию будет использоваться перенаправление на полную страницу.
Сведения о методе
initializeFlags()
/** @override */
protected initializeFlags(): void;Возвращаемое значение
void
overrideWith(sourceFlags)
/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;Параметры
- sourceFlags
- ISPHttpClientConfiguration