Поделиться через

AppCredentials class

  • Ссылка
Пакет:
botframework-connector

Общая реализация проверки подлинности AppCredentials и кэш. Поддерживает любой поток учетных данных клиента ADAL. Подклассы могут реализовать refreshToken для получения маркера.

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

AppCredentials(string, string, string)

Инициализирует новый экземпляр класса AppCredentials.

Свойства

appId
oAuthEndpoint

Возвращает используемую конечную точку OAuth. Задает используемую конечную точку OAuth.
oAuthScope

Возвращает область OAuth, используемую. Задает область OAuth, используемую.
tokenCacheKey

Методы

getToken(boolean)

Возвращает маркер доступа OAuth.
isTrustedServiceUrl(string)

Проверяет, является ли URL-адрес службы доверенным узлом или нет.
signRequest(WebResource)

Примените учетные данные к HTTP-запросу.
trustServiceUrl(string, Date)

Добавляет узел URL-адреса службы в доверенные узлы. Если срок действия не указан, дата окончания срока действия будет текущей (utc) датой + 1 день.

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

AppCredentials(string, string, string)

Инициализирует новый экземпляр класса AppCredentials.

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

Параметры

appId

string

Идентификатор приложения.

channelAuthTenant

string

Необязательный. Клиент маркера oauth.

oAuthScope

string

Область маркера.

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

appId 

appId: string

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

string

oAuthEndpoint

Возвращает используемую конечную точку OAuth. Задает используемую конечную точку OAuth.

string oAuthEndpoint

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

string

Используется OAuthEndpoint.

oAuthScope

Возвращает область OAuth, используемую. Задает область OAuth, используемую.

string oAuthScope

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

string

Область OAuth, используемая.

tokenCacheKey 

tokenCacheKey: string

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

string

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

getToken(boolean)

Возвращает маркер доступа OAuth.

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

Параметры

forceRefresh

boolean

Значение true для принудительного обновления маркера; или false, чтобы получить кэшированный маркер, если он существует.

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

Promise<string>

Обещание, представляющее рабочую очередь для выполнения.

Комментарии

Если обещание выполнено успешно, результат содержит строку маркера доступа.

isTrustedServiceUrl(string)

Предупреждение

Теперь этот API является нерекомендуемым.

Проверяет, является ли URL-адрес службы доверенным узлом или нет.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Параметры

serviceUrl

string

URL-адрес службы

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

boolean

Значение True, если узел URL-адреса службы является доверенным; Значение false. В противном случае.

signRequest(WebResource)

Примените учетные данные к HTTP-запросу.

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

Параметры

webResource

WebResource

HTTP-запрос WebResource.

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

Promise<WebResource>

Обещание, представляющее асинхронную операцию.

trustServiceUrl(string, Date)

Предупреждение

Теперь этот API является нерекомендуемым.

Добавляет узел URL-адреса службы в доверенные узлы. Если срок действия не указан, дата окончания срока действия будет текущей (utc) датой + 1 день.

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

Параметры

serviceUrl

string

URL-адрес службы

expiration

Date