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

MicrosoftAppCredentials class

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

Реализация проверки подлинности MicrosoftAppCredentials

Extends
AppCredentials

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

MicrosoftAppCredentials(string, string, string, string)

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

Свойства

appPassword
Empty

Пустой набор учетных данных.
oAuthEndpoint

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

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

Унаследованные свойства

appId
tokenCacheKey

Наследуемые методы

getToken(boolean)

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

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

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

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

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

MicrosoftAppCredentials(string, string, string, string)

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

new MicrosoftAppCredentials(appId: string, appPassword: string, channelAuthTenant?: string, oAuthScope?: string)

Параметры

appId

string

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

appPassword

string

Пароль приложения Майкрософт.

channelAuthTenant

string

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

oAuthScope

string

Необязательный. Область маркера.

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

appPassword 

appPassword: string

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

string

Empty

Пустой набор учетных данных.

static Empty: MicrosoftAppCredentials

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

MicrosoftAppCredentials

oAuthEndpoint

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

string oAuthEndpoint

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

string

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

oAuthScope

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

string oAuthScope

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

string

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

Сведения об унаследованном свойстве

appId 

appId: string

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

string

наследуется отAppCredentials.appId

tokenCacheKey 

tokenCacheKey: string

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

string

наследуется отAppCredentials.tokenCacheKey

Сведения о наследуемом методе

getToken(boolean)

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

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

Параметры

forceRefresh

boolean

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

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

Promise<string>

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

Комментарии

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

унаследован отAppCredentials.getToken

isTrustedServiceUrl(string)

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

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

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

static function isTrustedServiceUrl(serviceUrl: string): boolean

Параметры

serviceUrl

string

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

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

boolean

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

наследуется отAppCredentials.isTrustedServiceUrl

signRequest(WebResource)

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

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

Параметры

webResource

WebResource

HTTP-запрос WebResource.

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

Promise<WebResource>

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

унаследовано отAppCredentials.signRequest

trustServiceUrl(string, Date)

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

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

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

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

Параметры

serviceUrl

string

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

expiration

Date

унаследован отAppCredentials.trustServiceUrl