BotConfiguration class

Пакет:

botframework-config

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

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

See https://aka.ms/bot-file-basics for more information.

Extends

BotConfigurationBase

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

BotConfiguration()

Создает новый экземпляр BotConfigurationBase.

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

description
name
padlock
services
version

Методы

clearSecret()	Очистить секрет.
decrypt(string)	Расшифровка всех значений в конфигурации памяти.
encrypt(string)	Зашифруйте все значения в конфигурации памяти.
fromJSON(Partial<IBotConfiguration>)	Загрузите конфигурацию бота из JSON.
generateKey()	Создайте новый ключ, подходящий для шифрования.
getPath()	Возвращает путь, из который была загружена эта конфигурация. .save() сохранится в этом пути.
load(string, string)	Загрузите конфигурацию из bot-файла.
loadBotFromFolder(string, string)	Загрузите конфигурацию бота, выполнив поиск в папке и загрузив первый файл .bot в папке.
loadBotFromFolderSync(string, string)	Загрузите конфигурацию бота, выполнив поиск в папке и загрузив первый файл .bot в папке. (блокировка)
loadSync(string, string)	Загрузите конфигурацию из bot-файла. (блокировка)
save(string)	Сохраните файл с секретом.
saveAs(string, string)	Сохраните конфигурацию в файл .bot.
saveAsSync(string, string)	Сохраните конфигурацию в файл .bot. (блокировка)
saveSync(string)	Сохраните файл с секретом. (блокировка)
validateSecret(string)	Убедитесь, что секрет правильно, расшифровка секрета с ним.

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

connectService(IConnectedService)	Подключите службу к файлу бота.
disconnectService(string)	Удаление службы по идентификатору.
disconnectServiceByNameOrId(string)	Удаление службы по имени или идентификатору.
findService(string)	Поиск службы по идентификатору.
findServiceByNameOrId(string)	Поиск службы по имени или идентификатору.
serviceFromJSON(IConnectedService)	Загружает экземпляр ConnectedService с конфигурацией службы на основе JSON.
toJSON()	Создает версию на основе JSON текущего бота.

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

BotConfiguration()

Создает новый экземпляр BotConfigurationBase.

new BotConfiguration()

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

description

description: string

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

string

наследуется отBotConfigurationBase.description

name

name: string

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

string

унаследован отBotConfigurationBase.name

padlock

padlock: string

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

string

наследуется отBotConfigurationBase.padlock

services

services: IConnectedService[]

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

IConnectedService[]

наследуется отBotConfigurationBase.services

version

version: string

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

string

наследуется отBotConfigurationBase.version

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

clearSecret()

Очистить секрет.

function clearSecret()

decrypt(string)

Расшифровка всех значений в конфигурации памяти.

function decrypt(secret?: string)

Параметры

secret

string

Секрет расшифровки.

encrypt(string)

Зашифруйте все значения в конфигурации памяти.

function encrypt(secret: string)

Параметры

secret

string

Секрет для шифрования.

fromJSON(Partial<IBotConfiguration>)

Загрузите конфигурацию бота из JSON.

static function fromJSON(source?: Partial<IBotConfiguration>): BotConfiguration

Параметры

source

Partial<IBotConfiguration>

Конфигурация на основе JSON.

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

BotConfiguration

Новый экземпляр BotConfiguration.

generateKey()

Создайте новый ключ, подходящий для шифрования.

static function generateKey(): string

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

string

Ключ для использования с методом шифрования.

getPath()

Возвращает путь, из который была загружена эта конфигурация. .save() сохранится в этом пути.

function getPath(): string

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

string

Путь.

load(string, string)

Загрузите конфигурацию из bot-файла.

static function load(botpath: string, secret?: string): Promise<BotConfiguration>

Параметры

botpath

string

Путь к файлу бота.

secret

string

(Необязательно) секрет, используемый для расшифровки файла бота.

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

Promise<BotConfiguration>

Обещание с новым экземпляром BotConfiguration.

loadBotFromFolder(string, string)

Загрузите конфигурацию бота, выполнив поиск в папке и загрузив первый файл .bot в папке.

static function loadBotFromFolder(folder?: string, secret?: string): Promise<BotConfiguration>

Параметры

folder

string

Папка (необязательно) для поиска файлов бота. Если не указан текущий рабочий каталог, используется.

secret

string

(Необязательно) секрет, используемый для расшифровки файла бота.

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

Promise<BotConfiguration>

Обещание с новым экземпляром BotConfiguration.

loadBotFromFolderSync(string, string)

Загрузите конфигурацию бота, выполнив поиск в папке и загрузив первый файл .bot в папке. (блокировка)

static function loadBotFromFolderSync(folder?: string, secret?: string): BotConfiguration

Параметры

folder

string

Папка (необязательно) для поиска файлов бота. Если не указан текущий рабочий каталог, используется.

secret

string

(Необязательно) секрет, используемый для расшифровки файла бота.

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

BotConfiguration

Новый экземпляр BotConfiguration.

loadSync(string, string)

Загрузите конфигурацию из bot-файла. (блокировка)

static function loadSync(botpath: string, secret?: string): BotConfiguration

Параметры

botpath

string

Путь к файлу бота.

secret

string

(Необязательно) секрет, используемый для расшифровки файла бота.

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

BotConfiguration

Новый экземпляр BotConfiguration.

save(string)

Сохраните файл с секретом.

function save(secret?: string): Promise<void>

Параметры

secret

string

(Необязательно) секрет, используемый для шифрования файла бота.

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

Promise<void>

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

saveAs(string, string)

Сохраните конфигурацию в файл .bot.

function saveAs(botpath: string, secret?: string): Promise<void>

Параметры

botpath

string

Путь к файлу бота.

secret

string

(Необязательно) секрет, используемый для шифрования файла бота.

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

Promise<void>

saveAsSync(string, string)

Сохраните конфигурацию в файл .bot. (блокировка)

function saveAsSync(botpath: string, secret?: string)

Параметры

botpath

string

Путь к файлу бота.

secret

string

(Необязательно) секрет, используемый для шифрования файла бота.

saveSync(string)

Сохраните файл с секретом. (блокировка)

function saveSync(secret?: string)

Параметры

secret

string

(Необязательно) секрет, используемый для шифрования файла бота.

validateSecret(string)

Убедитесь, что секрет правильно, расшифровка секрета с ним.

function validateSecret(secret: string)

Параметры

secret

string

Секрет для использования.

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

connectService(IConnectedService)

Подключите службу к файлу бота.

function connectService(newService: IConnectedService): string

Параметры

newService

IConnectedService

Служба для добавления.

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

string

Назначенный идентификатор для службы.

унаследован отBotConfigurationBase.connectService

disconnectService(string)

Удаление службы по идентификатору.

function disconnectService(id: string)

Параметры

id

string

Идентификатор службы для удаления.

наследуется отBotConfigurationBase.disconnectService

disconnectServiceByNameOrId(string)

Удаление службы по имени или идентификатору.

function disconnectServiceByNameOrId(nameOrId: string): IConnectedService

Параметры

nameOrId

string

Имя или идентификатор службы для удаления.

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

IConnectedService

Удаленная служба IConnectedService на основе предоставленного имени или идентификатора.

наследуется отBotConfigurationBase.disconnectServiceByNameOrId

findService(string)

Поиск службы по идентификатору.

function findService(id: string): IConnectedService

Параметры

id

string

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

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

IConnectedService

IConnectedService на основе предоставленного идентификатора.

наследуется отBotConfigurationBase.findService

findServiceByNameOrId(string)

Поиск службы по имени или идентификатору.

function findServiceByNameOrId(nameOrId: string): IConnectedService

Параметры

nameOrId

string

Имя или идентификатор службы для поиска.

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

IConnectedService

IConnectedService на основе предоставленного имени или идентификатора.

наследуется отBotConfigurationBase.findServiceByNameOrId

serviceFromJSON(IConnectedService)

Загружает экземпляр ConnectedService с конфигурацией службы на основе JSON.

static function serviceFromJSON(service: IConnectedService): ConnectedService

Параметры

service

IConnectedService

Конфигурация службы на основе JSON.

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

ConnectedService

Новый экземпляр ConnectedService.

унаследован отBotConfigurationBase.serviceFromJSON

toJSON()

Создает версию на основе JSON текущего бота.

function toJSON(): IBotConfiguration

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

IBotConfiguration

JSON-файл IBotConfiguration.

унаследован отBotConfigurationBase.toJSON