SPHttpClientBatch class
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Класс SPHttpClientBatch накапливает ряд вызовов службы REST и передает их в едином пакете ODATA. Документация по этому протоколу находится здесь: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html
Порядок использования: вызывается SPHttpClientBatch.fetch() для постановки в очередь каждого отдельного запроса, затем следует вызов SPHttpClientBatch.execute() для выполнения пакетной операции. Метод execute() возвращает обещание, исполняемое по завершении действительного вызова REST. Каждый вызов fetch() также возвращает обещание, исполняемое объектом SPHttpClientResponse для данного конкретного запроса.
Комментарии
Конструктор для этого класса помечен как внутренний. Сторонний код не должен напрямую вызывать конструктор или создавать подклассы, расширяющие класс SPHttpClientBatch.
Свойства
| configurations | Стандартные предопределенные объекты SPHttpClientBatchConfigurations для использования с классом SPHttpClientBatch. |
Методы
| execute() | Исполняет объединенные в пакет запросы, поставленные в очередь с помощью SPHttpClientBatch.fetch(). |
| fetch(url, configuration, options) | Ставит в очередь новый запрос и возвращает обещание, которое может быть использовано для доступа к ответу сервера (после выполнения execute()). |
| get(url, configuration, options) | Вызывает fetch(), но задает метод GET. |
| post(url, configuration, options) | Вызывает fetch(), но задает метод POST. |
Сведения о свойстве
configurations
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Стандартные предопределенные объекты SPHttpClientBatchConfigurations для использования с классом SPHttpClientBatch.
static readonly configurations: ISPHttpClientBatchConfigurations;Значение свойства
Сведения о методе
execute()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Исполняет объединенные в пакет запросы, поставленные в очередь с помощью SPHttpClientBatch.fetch().
execute(): Promise<SPHttpClientBatch>;Возвращаемое значение
Promise<SPHttpClientBatch>
fetch(url, configuration, options)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Ставит в очередь новый запрос и возвращает обещание, которое может быть использовано для доступа к ответу сервера (после выполнения execute()).
fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Параметры
- url
-
string
URL-адрес для получения
- configuration
- SPHttpClientBatchConfiguration
определяет поведение по умолчанию этого запроса; обычно это номер последней версии из SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
дополнительные параметры, влияющие на запрос
Возвращаемое значение
Promise<SPHttpClientResponse>
Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.
Комментарии
Параметры для этой функции в целом те же, что и для стандарта WHATWG API, документация по которому находится здесь:
https://fetch.spec.whatwg.org/
Однако обратите внимание на то, что определенные заголовки REST игнорируются или недопустимы внутри пакета. Дополнительные сведения см. в документации по ODATA.
При вызове метода execute() он направит запрос POST к URL-адресу, например "http://example.com/sites/sample/_api/$batch". Обычно SPHttpClientBatch может успешно угадать соответствующий URL-адрес SPWeb, найдя зарезервированный сегмент URL-адреса, например "_api" в первом URL-адресе, переданном в fetch(). В противном случае укажите его с помощью ISPHttpClientBatchCreationOptions.webUrl.
get(url, configuration, options)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Вызывает fetch(), но задает метод GET.
get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Параметры
- url
-
string
URL-адрес для получения
- configuration
- SPHttpClientBatchConfiguration
определяет поведение по умолчанию этого запроса; обычно это номер последней версии из SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
дополнительные параметры, влияющие на запрос
Возвращаемое значение
Promise<SPHttpClientResponse>
Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.
post(url, configuration, options)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Вызывает fetch(), но задает метод POST.
post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Параметры
- url
-
string
URL-адрес для получения
- configuration
- SPHttpClientBatchConfiguration
определяет поведение по умолчанию этого запроса; обычно это номер последней версии из SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
дополнительные параметры, влияющие на запрос
Возвращаемое значение
Promise<SPHttpClientResponse>
Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.