@microsoft/sp-http-base package
Capa de comunicación base para SharePoint Framework
Clases
AadHttpClient |
AadHttpClient se usa para realizar llamadas REST a una aplicación de Azure AD. |
AadHttpClientConfiguration |
Configuración de HttpClient. |
AadHttpClientFactory |
Devuelve una versión preinicializada de AadHttpClient para una dirección URL de recurso determinada. Para obtener más información: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient |
AadHttpClientResponse |
Subclase Response devuelta por métodos como |
AadTokenProvider |
Esta clase permite a un desarrollador obtener tokens de OAuth2 de Azure AD. Los tokens de OAuth2 se usan para autenticar al usuario desde la página de SharePoint en otros servicios como PowerBI, Sway, Exchange, Yammer, etc. |
AadTokenProviderFactory |
Devuelve una versión preinicializada de AadTokenProviderFactory. |
BeforeRedirectEventArgs |
Argumentos para antes de redirigir para una autenticación de página completa |
DigestCache |
IDigestCache es un servicio interno utilizado por SPHttpClient para mantener una caché de resúmenes de solicitudes para cada dirección URL SPWeb. Un resumen de solicitud es un token de seguridad que el servidor de SharePoint necesita para cualquier operación de escritura REST, especificada a través del encabezado HTTP "X-RequestDigest". Se obtiene llamando al punto de conexión REST "/_api/contextinfo" y expira después de una cantidad de tiempo configurable por el servidor. Para obtener más información, vea el artículo de MSDN "Complete basic operations using SharePoint 2013 REST endpoints" (Completar operaciones básicas con puntos de conexión REST de SharePoint 2013) |
HttpClient |
HttpClient implementa un conjunto básico de características para realizar operaciones REST en un servicio genérico. |
HttpClientConfiguration |
Configuración de HttpClient. |
HttpClientResponse |
Subclase Response devuelta por métodos como HttpClient.fetch(). |
ODataVersion |
Representa la versión admitida del encabezado "OData-Version", que forma parte del estándar Open Data Protocol. |
PopupEventArgs |
Argumentos para un evento emergente si se requiere interacción durante el flujo de inicio de sesión. |
SPHttpClient |
SPHttpClient se usa para realizar llamadas de REST en SharePoint. Agrega encabezados predeterminados, administra la síntesis necesaria para escrituras y recopila telemetría que ayuda al servicio a supervisar el rendimiento de una aplicación. |
SPHttpClientBatch |
La clase SPHttpClientBatch acumula varias llamadas al servicio REST y las transmite como un único lote ODATA. Este protocolo se documenta aquí: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html El uso consiste en llamar a SPHttpClientBatch.fetch() para poner en cola cada solicitud individual y, a continuación, llamar a SPHttpClientBatch.execute() para ejecutar la operación por lotes. El método execute() devuelve una promesa que se resuelve cuando se ha completado la llamada REST real. Cada llamada a fetch() también devuelve una promesa que se resolverá con un objeto SPHttpClientResponse para esa solicitud en particular. |
SPHttpClientBatchConfiguration |
Configuración de SPHttpClientBatch. |
SPHttpClientCommonConfiguration |
Clase base común para SPHttpClientConfiguration y SPHttpClientBatchConfiguration. |
SPHttpClientConfiguration |
Configuración de SPHttpClient. |
SPHttpClientResponse |
Subclase Response devuelta por métodos como SPHttpClient.fetch(). |
TokenAcquisitionEventArgs |
Argumentos para un evento de error de adquisición de tokens. |
Interfaces
IAadHttpClientConfiguration |
Interfaz de marcas para HttpClientConfiguration. |
IAadHttpClientConfigurations |
Configuraciones estándar para AadHttpClient. |
IAadHttpClientOptions |
Interfaz para invalidar el comportamiento predeterminado de AadHttpClient. |
IAadTokenProvider |
Esta clase permite a un desarrollador obtener tokens de OAuth2 de Azure AD. Los tokens de OAuth2 se usan para autenticar al usuario desde la página de SharePoint en otros servicios como PowerBI, Sway, Exchange, Yammer, etc. |
IAadTokenProviderConfiguration |
Cadenas necesarias para construir un AadTokenProvider. |
IBeforeRedirectEventArgs |
Representa los argumentos usados antes de redirigir el evento. |
IDigestCache |
IDigestCache es un servicio interno utilizado por SPHttpClient para mantener una caché de resúmenes de solicitudes para cada dirección URL SPWeb. Un resumen de solicitud es un token de seguridad que el servidor de SharePoint necesita para cualquier operación de escritura REST, especificada a través del encabezado HTTP "X-RequestDigest". Se obtiene llamando al punto de conexión REST "/_api/contextinfo" y expira después de una cantidad de tiempo configurable por el servidor. Para obtener más información, vea el artículo de MSDN "Complete basic operations using SharePoint 2013 REST endpoints" (Completar operaciones básicas con puntos de conexión REST de SharePoint 2013) |
IGetTokenOptions | |
IHttpClientConfiguration |
Interfaz de marcas para HttpClientConfiguration. |
IHttpClientConfigurations |
Configuraciones estándar para HttpClient. |
IHttpClientOptions |
Opciones para HttpClient |
IPopupEventArgs |
Representa los argumentos usados antes del evento emergente. |
ISPHttpClientBatchConfiguration |
Interfaz Flags para SPHttpClientBatchConfiguration. |
ISPHttpClientBatchConfigurations |
Configuraciones estándar para SPHttpClient. |
ISPHttpClientBatchCreationOptions |
Esta interfaz se pasa al constructor SPHttpClientBatch. Especifica las opciones que afectan a todo el lote. |
ISPHttpClientBatchOptions |
Esta interfaz define las opciones de una solicitud REST individual que forma parte de un SPHttpClientBatch. Se basa en los parámetros estándar de la API WHATWG que se documentan aquí: https://fetch.spec.whatwg.org/ |
ISPHttpClientCommonConfiguration |
Interfaz de marcas para SPHttpClientCommonConfiguration. |
ISPHttpClientConfiguration |
Interfaz de marcas para SPHttpClientConfiguration. |
ISPHttpClientConfigurations |
Configuraciones estándar para SPHttpClient. |
ISPHttpClientOptions |
Esta interfaz define las opciones para las operaciones SPHttpClient, como get(), post(), fetch(), etc. Se basa en los parámetros estándar de API de WHATWG que se mencionan aquí: https://fetch.spec.whatwg.org/ |
ITokenAcquisitionEventArgs |
Representa los argumentos utilizados para generar un evento de error de confirmación de token. |
Enumeraciones
IAuthenticationScheme |
Opciones para el esquema de autenticación |
SPHttpHeader |
Encabezados HTTP estándar usados con SPHttpClient |