Compartir a través de

AppCredentials class

  • Referencia
Paquete:
botframework-connector

Implementación y caché generales de la autenticación de AppCredentials. Admite cualquier flujo de credenciales de cliente de ADAL. Las subclases pueden implementar refreshToken para adquirir el token.

Constructores

AppCredentials(string, string, string)

Inicializa una nueva instancia de la clase AppCredentials.

Propiedades

appId
oAuthEndpoint

Obtiene el punto de conexión de OAuth que se va a usar. Establece el punto de conexión de OAuth que se va a usar.
oAuthScope

Obtiene el ámbito de OAuth que se va a usar. Establece el ámbito de OAuth que se va a usar.
tokenCacheKey

Métodos

getToken(boolean)

Obtiene un token de acceso de OAuth.
isTrustedServiceUrl(string)

Comprueba si la dirección URL del servicio es para un host de confianza o no.
signRequest(WebResource)

Aplique las credenciales a la solicitud HTTP.
trustServiceUrl(string, Date)

Agrega el host de la dirección URL del servicio a los hosts de confianza. Si no se proporciona la hora de expiración, la fecha de expiración será fecha actual (utc) + 1 día.

Detalles del constructor

AppCredentials(string, string, string)

Inicializa una nueva instancia de la clase AppCredentials.

new AppCredentials(appId: string, channelAuthTenant?: string, oAuthScope?: string)

Parámetros

appId

string

Id. de aplicación.

channelAuthTenant

string

Opcional. El inquilino del token de oauth.

oAuthScope

string

Ámbito del token.

Detalles de las propiedades

appId 

appId: string

Valor de propiedad

string

oAuthEndpoint

Obtiene el punto de conexión de OAuth que se va a usar. Establece el punto de conexión de OAuth que se va a usar.

string oAuthEndpoint

Valor de propiedad

string

OAuthEndpoint que se va a usar.

oAuthScope

Obtiene el ámbito de OAuth que se va a usar. Establece el ámbito de OAuth que se va a usar.

string oAuthScope

Valor de propiedad

string

Ámbito de OAuth que se va a usar.

tokenCacheKey 

tokenCacheKey: string

Valor de propiedad

string

Detalles del método

getToken(boolean)

Obtiene un token de acceso de OAuth.

function getToken(forceRefresh?: boolean): Promise<string>

Parámetros

forceRefresh

boolean

True para forzar una actualización del token; o false para obtener un token almacenado en caché si existe.

Devoluciones

Promise<string>

Promesa que representa el trabajo en cola que se va a ejecutar.

Comentarios

Si la promesa se realiza correctamente, el resultado contiene la cadena del token de acceso.

isTrustedServiceUrl(string)

Advertencia

Esta API ya está en desuso.

Comprueba si la dirección URL del servicio es para un host de confianza o no.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parámetros

serviceUrl

string

Dirección URL del servicio

Devoluciones

boolean

True si el host de la dirección URL del servicio es de confianza; False en caso contrario.

signRequest(WebResource)

Aplique las credenciales a la solicitud HTTP.

function signRequest(webResource: WebResource): Promise<WebResource>

Parámetros

webResource

WebResource

Solicitud HTTP de WebResource.

Devoluciones

Promise<WebResource>

Promesa que representa la operación asincrónica.

trustServiceUrl(string, Date)

Advertencia

Esta API ya está en desuso.

Agrega el host de la dirección URL del servicio a los hosts de confianza. Si no se proporciona la hora de expiración, la fecha de expiración será fecha actual (utc) + 1 día.

static function trustServiceUrl(serviceUrl: string, expiration?: Date)

Parámetros

serviceUrl

string

Dirección URL del servicio

expiration

Date