BotConfiguration class

Paket:

botframework-config

Warnung

Diese API ist nun veraltet.

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

Extends

BotConfigurationBase

Konstruktoren

BotConfiguration()

Erstellt eine neue BotConfigurationBase-Instanz.

Geerbte Eigenschaften

description
name
padlock
services
version

Methoden

clearSecret()	Geheimer Schlüssel löschen.
decrypt(string)	Entschlüsseln Sie alle Werte in der Speicherkonfiguration.
encrypt(string)	Verschlüsseln Sie alle Werte in der Speicherkonfiguration.
fromJSON(Partial<IBotConfiguration>)	Laden Sie die Bot-Konfiguration aus einem JSON-Code.
generateKey()	Generieren Sie einen neuen Schlüssel, der für die Verschlüsselung geeignet ist.
getPath()	Ruft den Pfad ab, aus dem diese Konfiguration geladen wurde. .save() wird in diesem Pfad gespeichert.
load(string, string)	Laden Sie die Konfiguration aus einer BOT-Datei.
loadBotFromFolder(string, string)	Laden Sie die Bot-Konfiguration, indem Sie in einem Ordner suchen und die erste BOT-Datei im Ordner laden.
loadBotFromFolderSync(string, string)	Laden Sie die Bot-Konfiguration, indem Sie in einem Ordner suchen und die erste BOT-Datei im Ordner laden. (Blockieren)
loadSync(string, string)	Laden Sie die Konfiguration aus einer BOT-Datei. (Blockieren)
save(string)	Speichern Sie die Datei mit geheimen Schlüsseln.
saveAs(string, string)	Speichern Sie die Konfiguration in einer BOT-Datei.
saveAsSync(string, string)	Speichern Sie die Konfiguration in einer BOT-Datei. (Blockieren)
saveSync(string)	Speichern Sie die Datei mit geheimen Schlüsseln. (Blockieren)
validateSecret(string)	Stellen Sie sicher, dass der geheime Schlüssel korrekt ist, indem Sie den secretKey damit entschlüsseln.

Geerbte Methoden

connectService(IConnectedService)	Verbinden Sie einen Dienst mit der Botdatei.
disconnectService(string)	Dienst nach ID entfernen.
disconnectServiceByNameOrId(string)	Entfernen Sie den Dienst anhand des Namens oder der ID.
findService(string)	Suchen Sie den Dienst nach ID.
findServiceByNameOrId(string)	Suchen Sie den Dienst anhand des Namens oder der ID.
serviceFromJSON(IConnectedService)	Lädt eine ConnectedService-Instanz mit einer JSON-basierten Dienstkonfiguration.
toJSON()	Erstellt eine JSON-basierte Version des aktuellen Bots.

Details zum Konstruktor

BotConfiguration()

Erstellt eine neue BotConfigurationBase-Instanz.

new BotConfiguration()

Geerbte Eigenschaftsdetails

description

description: string

Eigenschaftswert

string

vonBotConfigurationBase.description geerbt

name

name: string

Eigenschaftswert

string

geerbt vonBotConfigurationBase.name

padlock

padlock: string

Eigenschaftswert

string

vonBotConfigurationBase.padlock geerbt

services

services: IConnectedService[]

Eigenschaftswert

IConnectedService[]

vonBotConfigurationBase.services geerbt

version

version: string

Eigenschaftswert

string

vonBotConfigurationBase.version geerbt

Details zur Methode

clearSecret()

Geheimer Schlüssel löschen.

function clearSecret()

decrypt(string)

Entschlüsseln Sie alle Werte in der Speicherkonfiguration.

function decrypt(secret?: string)

Parameter

secret

string

Geheimer Schlüssel zum Entschlüsseln.

encrypt(string)

Verschlüsseln Sie alle Werte in der Speicherkonfiguration.

function encrypt(secret: string)

Parameter

secret

string

Geheimer Schlüssel zum Verschlüsseln.

fromJSON(Partial<IBotConfiguration>)

Laden Sie die Bot-Konfiguration aus einem JSON-Code.

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

Parameter

source

Partial<IBotConfiguration>

JSON-basierte Konfiguration.

Gibt zurück

BotConfiguration

Eine neue BotConfiguration-Instanz.

generateKey()

Generieren Sie einen neuen Schlüssel, der für die Verschlüsselung geeignet ist.

static function generateKey(): string

Gibt zurück

string

Schlüssel zur Verwendung mit der verschlüsseln Methode.

getPath()

Ruft den Pfad ab, aus dem diese Konfiguration geladen wurde. .save() wird in diesem Pfad gespeichert.

function getPath(): string

Gibt zurück

string

Der Pfad.

load(string, string)

Laden Sie die Konfiguration aus einer BOT-Datei.

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

Parameter

botpath

string

Pfad zur Botdatei.

secret

string

(Optional) Geheimer Schlüssel, der zum Entschlüsseln der Bot-Datei verwendet wird.

Gibt zurück

Promise<BotConfiguration>

Eine Zusage mit der neuen BotConfiguration-Instanz.

loadBotFromFolder(string, string)

Laden Sie die Bot-Konfiguration, indem Sie in einem Ordner suchen und die erste BOT-Datei im Ordner laden.

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

Parameter

folder

string

(Optional) Ordner zum Suchen nach Botdateien. Wenn nicht angegeben, wird das aktuelle Arbeitsverzeichnis verwendet.

secret

string

(Optional) Geheimer Schlüssel, der zum Entschlüsseln der Bot-Datei verwendet wird.

Gibt zurück

Promise<BotConfiguration>

Eine Zusage mit der neuen BotConfiguration-Instanz.

loadBotFromFolderSync(string, string)

Laden Sie die Bot-Konfiguration, indem Sie in einem Ordner suchen und die erste BOT-Datei im Ordner laden. (Blockieren)

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

Parameter

folder

string

(Optional) Ordner zum Suchen nach Botdateien. Wenn nicht angegeben, wird das aktuelle Arbeitsverzeichnis verwendet.

secret

string

(Optional) Geheimer Schlüssel, der zum Entschlüsseln der Bot-Datei verwendet wird.

Gibt zurück

BotConfiguration

Eine neue BotConfiguration-Instanz.

loadSync(string, string)

Laden Sie die Konfiguration aus einer BOT-Datei. (Blockieren)

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

Parameter

botpath

string

Pfad zur Botdatei.

secret

string

(Optional) Geheimer Schlüssel, der zum Entschlüsseln der Bot-Datei verwendet wird.

Gibt zurück

BotConfiguration

Eine neue BotConfiguration-Instanz.

save(string)

Speichern Sie die Datei mit geheimen Schlüsseln.

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

Parameter

secret

string

(Optional) geheimer Schlüssel, der zum Verschlüsseln der Botdatei verwendet wird.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt.

saveAs(string, string)

Speichern Sie die Konfiguration in einer BOT-Datei.

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

Parameter

botpath

string

Pfad zur Botdatei.

secret

string

(Optional) geheimer Schlüssel, der zum Verschlüsseln der Botdatei verwendet wird.

Gibt zurück

Promise<void>

saveAsSync(string, string)

Speichern Sie die Konfiguration in einer BOT-Datei. (Blockieren)

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

Parameter

botpath

string

Pfad zur Botdatei.

secret

string

(Optional) geheimer Schlüssel, der zum Verschlüsseln der Botdatei verwendet wird.

saveSync(string)

Speichern Sie die Datei mit geheimen Schlüsseln. (Blockieren)

function saveSync(secret?: string)

Parameter

secret

string

(Optional) geheimer Schlüssel, der zum Verschlüsseln der Botdatei verwendet wird.

validateSecret(string)

Stellen Sie sicher, dass der geheime Schlüssel korrekt ist, indem Sie den secretKey damit entschlüsseln.

function validateSecret(secret: string)

Parameter

secret

string

Geheimer Schlüssel, der verwendet werden soll.

Details zur geerbten Methode

connectService(IConnectedService)

Verbinden Sie einen Dienst mit der Botdatei.

function connectService(newService: IConnectedService): string

Parameter

newService

IConnectedService

Dienst, der hinzugefügt werden soll.

Gibt zurück

string

Zugewiesene ID für den Dienst.

vonBotConfigurationBase.connectService

disconnectService(string)

Dienst nach ID entfernen.

function disconnectService(id: string)

Parameter

id

string

ID des zu entfernenden Diensts.

VonBotConfigurationBase.disconnectService geerbt

disconnectServiceByNameOrId(string)

Entfernen Sie den Dienst anhand des Namens oder der ID.

function disconnectServiceByNameOrId(nameOrId: string): IConnectedService

Parameter

nameOrId

string

Name oder ID des zu entfernenden Diensts.

Gibt zurück

IConnectedService

Der entfernte IConnectedService basierend auf dem angegebenen Namen oder der ANGEGEBENEN ID.

Geerbt vonBotConfigurationBase.disconnectServiceByNameOrId

findService(string)

Suchen Sie den Dienst nach ID.

function findService(id: string): IConnectedService

Parameter

id

string

ID des zu findenden Diensts.

Gibt zurück

IConnectedService

Der IConnectedService basierend auf der bereitgestellten ID.

VonBotConfigurationBase.findService geerbt

findServiceByNameOrId(string)

Suchen Sie den Dienst anhand des Namens oder der ID.

function findServiceByNameOrId(nameOrId: string): IConnectedService

Parameter

nameOrId

string

Name oder ID des zu suchenden Diensts.

Gibt zurück

IConnectedService

Der IConnectedService basiert auf dem angegebenen Namen oder der angegebenen ID.

Geerbt vonBotConfigurationBase.findServiceByNameOrId

serviceFromJSON(IConnectedService)

Lädt eine ConnectedService-Instanz mit einer JSON-basierten Dienstkonfiguration.

static function serviceFromJSON(service: IConnectedService): ConnectedService

Parameter

service

IConnectedService

JSON-basierte Dienstkonfiguration.

Gibt zurück

ConnectedService

Eine neue ConnectedService-Instanz.

vonBotConfigurationBase.serviceFromJSON geerbt

toJSON()

Erstellt eine JSON-basierte Version des aktuellen Bots.

function toJSON(): IBotConfiguration

Gibt zurück

IBotConfiguration

Ein IBotConfiguration-JSON.An IBotConfiguration JSON.

vonBotConfigurationBase.toJSON geerbt