BotConfiguration class

Référence

Paquet:: botframework-config

Avertissement

Cette API est à présent déconseillée.

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

Extends: BotConfigurationBase

Constructeurs

BotConfiguration()

Crée une instance BotConfigurationBase.

Propriétés héritées

description
name
padlock
services
version

Méthodes

clearSecret()	Effacer le secret.
decrypt(string)	Déchiffrer toutes les valeurs de la configuration en mémoire.
encrypt(string)	Chiffrer toutes les valeurs dans la configuration mémoire.
fromJSON(Partial<IBotConfiguration>)	Chargez la configuration du bot à partir d’un JSON.
generateKey()	Générez une nouvelle clé adaptée au chiffrement.
getPath()	Obtient le chemin d’accès à partir duquel cette configuration a été chargée. .save() est enregistré dans ce chemin d’accès.
load(string, string)	Chargez la configuration à partir d’un fichier .bot.
loadBotFromFolder(string, string)	Chargez la configuration du bot en recherchant un dossier et en chargeant le premier fichier .bot dans le dossier.
loadBotFromFolderSync(string, string)	Chargez la configuration du bot en recherchant un dossier et en chargeant le premier fichier .bot dans le dossier. (blocage)
loadSync(string, string)	Chargez la configuration à partir d’un fichier .bot. (blocage)
save(string)	Enregistrez le fichier avec un secret.
saveAs(string, string)	Enregistrez la configuration dans un fichier .bot.
saveAsSync(string, string)	Enregistrez la configuration dans un fichier .bot. (blocage)
saveSync(string)	Enregistrez le fichier avec un secret. (blocage)
validateSecret(string)	Assurez-vous que le secret est correct en déchiffrant le secretKey avec celui-ci.

Méthodes héritées

connectService(IConnectedService)	Connectez un service au fichier bot.
disconnectService(string)	Supprimez le service par ID.
disconnectServiceByNameOrId(string)	Supprimez le service par nom ou ID.
findService(string)	Recherchez le service par ID.
findServiceByNameOrId(string)	Recherchez le service par nom ou ID.
serviceFromJSON(IConnectedService)	Charge une instance ConnectedService en fonction d’une configuration de service JSON.
toJSON()	Crée une version JSON du bot actuel.

Détails du constructeur

BotConfiguration()

Crée une instance BotConfigurationBase.

new BotConfiguration()

Détails de la propriété héritée

description

description: string

Valeur de propriété

string

héritée deBotConfigurationBase.description

name

name: string

Valeur de propriété

string

héritée deBotConfigurationBase.name

padlock

padlock: string

Valeur de propriété

string

héritée debotConfigurationBase.padlock

services

services: IConnectedService[]

Valeur de propriété

IConnectedService[]

héritée deBotConfigurationBase.services

version

version: string

Valeur de propriété

string

héritée deBotConfigurationBase.version

Détails de la méthode

clearSecret()

Effacer le secret.

function clearSecret()

decrypt(string)

Déchiffrer toutes les valeurs de la configuration en mémoire.

function decrypt(secret?: string)

Paramètres

secret: string

Secret à déchiffrer.

encrypt(string)

Chiffrer toutes les valeurs dans la configuration mémoire.

function encrypt(secret: string)

Paramètres

secret: string

Secret à chiffrer.

fromJSON(Partial<IBotConfiguration>)

Chargez la configuration du bot à partir d’un JSON.

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

Paramètres

source: Partial<IBotConfiguration>

Configuration basée sur JSON.

Retours

BotConfiguration

Nouvelle instance BotConfiguration.

generateKey()

Générez une nouvelle clé adaptée au chiffrement.

static function generateKey(): string

Retours

string

Clé à utiliser avec la méthode chiffrer.

getPath()

Obtient le chemin d’accès à partir duquel cette configuration a été chargée. .save() est enregistré dans ce chemin d’accès.

function getPath(): string

Retours

string

Chemin d’accès.

load(string, string)

Chargez la configuration à partir d’un fichier .bot.

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

Paramètres

botpath: string

Chemin d’accès au fichier bot.

secret: string

(Facultatif) secret utilisé pour déchiffrer le fichier bot.

Retours

Promise<BotConfiguration>

Promesse avec la nouvelle instance BotConfiguration.

loadBotFromFolder(string, string)

Chargez la configuration du bot en recherchant un dossier et en chargeant le premier fichier .bot dans le dossier.

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

Paramètres

folder: string

(Facultatif) dossier pour rechercher des fichiers bot. Si le répertoire de travail actuel n’est pas spécifié, il est utilisé.

secret: string

(Facultatif) secret utilisé pour déchiffrer le fichier bot.

Retours

Promise<BotConfiguration>

Promesse avec la nouvelle instance BotConfiguration.

loadBotFromFolderSync(string, string)

Chargez la configuration du bot en recherchant un dossier et en chargeant le premier fichier .bot dans le dossier. (blocage)

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

Paramètres

folder: string

(Facultatif) dossier pour rechercher des fichiers bot. Si le répertoire de travail actuel n’est pas spécifié, il est utilisé.

secret: string

(Facultatif) secret utilisé pour déchiffrer le fichier bot.

Retours

BotConfiguration

Nouvelle instance BotConfiguration.

loadSync(string, string)

Chargez la configuration à partir d’un fichier .bot. (blocage)

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

Paramètres

botpath: string

Chemin d’accès au fichier bot.

secret: string

(Facultatif) secret utilisé pour déchiffrer le fichier bot.

Retours

BotConfiguration

Nouvelle instance BotConfiguration.

save(string)

Enregistrez le fichier avec un secret.

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

Paramètres

secret: string

(Facultatif) secret utilisé pour chiffrer le fichier bot.

Retours

Promise<void>

Promesse représentant l’opération asynchrone.

saveAs(string, string)

Enregistrez la configuration dans un fichier .bot.

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

Paramètres

botpath: string

Chemin d’accès au fichier bot.

secret: string

(Facultatif) secret utilisé pour chiffrer le fichier bot.

Retours

Promise<void>

saveAsSync(string, string)

Enregistrez la configuration dans un fichier .bot. (blocage)

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

Paramètres

botpath: string

Chemin d’accès au fichier bot.

secret: string

(Facultatif) secret utilisé pour chiffrer le fichier bot.

saveSync(string)

Enregistrez le fichier avec un secret. (blocage)

function saveSync(secret?: string)

Paramètres

secret: string

(Facultatif) secret utilisé pour chiffrer le fichier bot.

validateSecret(string)

Assurez-vous que le secret est correct en déchiffrant le secretKey avec celui-ci.

function validateSecret(secret: string)

Paramètres

secret: string

Secret à utiliser.

Détails de la méthode héritée

connectService(IConnectedService)

Connectez un service au fichier bot.

function connectService(newService: IConnectedService): string

Paramètres

newService: IConnectedService

Service à ajouter.

Retours

string

ID affecté pour le service.

héritée deBotConfigurationBase.connectService

disconnectService(string)

Supprimez le service par ID.

function disconnectService(id: string)

Paramètres

id: string

ID du service à supprimer.

héritée debotConfigurationBase.disconnectService

disconnectServiceByNameOrId(string)

Supprimez le service par nom ou ID.

function disconnectServiceByNameOrId(nameOrId: string): IConnectedService

Paramètres

nameOrId: string

Nom ou ID du service à supprimer.

Retours

IConnectedService

IConnectedService supprimé en fonction du nom ou de l’ID fourni.

héritée deBotConfigurationBase.disconnectServiceByNameOrId

findService(string)

Recherchez le service par ID.

function findService(id: string): IConnectedService

Paramètres

id: string

ID du service à rechercher.

Retours

IConnectedService

IConnectedService basé sur l’ID fourni.

héritée deBotConfigurationBase.findService

findServiceByNameOrId(string)

Recherchez le service par nom ou ID.

function findServiceByNameOrId(nameOrId: string): IConnectedService

Paramètres

nameOrId: string

Nom ou ID du service à rechercher.

Retours

IConnectedService

IConnectedService basé sur le nom ou l’ID fourni.

héritée deBotConfigurationBase.findServiceByNameOrId

serviceFromJSON(IConnectedService)

Charge une instance ConnectedService en fonction d’une configuration de service JSON.

static function serviceFromJSON(service: IConnectedService): ConnectedService

Paramètres

service: IConnectedService

Configuration du service basé sur JSON.

Retours

ConnectedService

Nouvelle instance ConnectedService.

héritée deBotConfigurationBase.serviceFromJSON

toJSON()

Crée une version JSON du bot actuel.

function toJSON(): IBotConfiguration

Retours

IBotConfiguration

Json IBotConfiguration.

héritée deBotConfigurationBase.toJSON