ResourceExplorer class

Paquete:

botbuilder-dialogs-declarative

Clase que proporciona acceso estándar a los recursos de contenido.

Constructores

ResourceExplorer(ResourceExplorerOptions)	Inicializa una nueva instancia de la clase ResourceExplorer.
ResourceExplorer(ResourceProvider[])	Inicializa una nueva instancia de la clase ResourceExplorer.

Propiedades

changed	Evento que se desencadena cuando se cambia un recurso.
resourceProviders	Obtiene proveedores de recursos.
resourceTypes	Obtiene las extensiones de identificador de tipo de recurso administradas por el Explorador de recursos.

Métodos

addFolder(string, boolean, boolean)	Agregue un recurso de carpeta.
addFolders(string, string[], boolean)	Agregar recursos de carpeta.
addResourceProvider(ResourceProvider)	Agregue un proveedor de recursos a los recursos administrados por el Explorador de recursos.
addResourceType(string)	Agregue un tipo de recurso al conjunto de tipos de recursos.
buildType<T, C>(string, C)	Tipo de compilación para $kind dados a partir de la configuración.
getResource(string)	Obtiene el recurso por identificador.
getResources(string)	Obtiene recursos de una extensión de tipo determinada.
loadType<T>(Resource)	Tipo de carga desde el recurso
loadType<T>(string)	Tipo de carga desde el recurso
refresh()	Vuelva a cargar los datos almacenados en caché.
registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)	Registre un tipo declarativo con el sistema del cargador de recursos.

Detalles del constructor

ResourceExplorer(ResourceExplorerOptions)

Inicializa una nueva instancia de la clase ResourceExplorer.

new ResourceExplorer(options?: ResourceExplorerOptions)

Parámetros

options

ResourceExplorerOptions

Opciones de configuración.

ResourceExplorer(ResourceProvider[])

Inicializa una nueva instancia de la clase ResourceExplorer.

new ResourceExplorer(providers: ResourceProvider[])

Parámetros

providers

ResourceProvider[]

Lista de ResourceProvider para inicializar la instancia actual.

Detalles de las propiedades

changed

Evento que se desencadena cuando se cambia un recurso.

any changed

Valor de propiedad

any

resourceProviders

Obtiene proveedores de recursos.

resourceProviders: ResourceProvider[]

Valor de propiedad

ResourceProvider[]

resourceTypes

Obtiene las extensiones de identificador de tipo de recurso administradas por el Explorador de recursos.

resourceTypes: Set<string>

Valor de propiedad

Set<string>

Detalles del método

addFolder(string, boolean, boolean)

Agregue un recurso de carpeta.

function addFolder(folder: string, includeSubFolders?: boolean, monitorChanges?: boolean): ResourceExplorer

Parámetros

folder

string

Carpeta que se va a incluir como un recurso.

includeSubFolders

boolean

Si se van a incluir subcarpetas.

monitorChanges

boolean

Indica si se deben realizar un seguimiento de los cambios.

Devoluciones

ResourceExplorer

Explorador de recursos para que pueda llamar fluidamente a varios métodos en el explorador de recursos.

addFolders(string, string[], boolean)

Agregar recursos de carpeta.

function addFolders(folder: string, ignoreFolders?: string[], monitorChanges?: boolean): ResourceExplorer

Parámetros

folder

string

Colección de carpetas que se van a incluir como recursos.

ignoreFolders

string[]

Corrija las subcarpetas que se van a omitir.

monitorChanges

boolean

Indica si se deben realizar un seguimiento de los cambios.

Devoluciones

ResourceExplorer

Explorador de recursos para que pueda llamar fluidamente a varios métodos en el explorador de recursos.

addResourceProvider(ResourceProvider)

Agregue un proveedor de recursos a los recursos administrados por el Explorador de recursos.

function addResourceProvider(resourceProvider: ResourceProvider): ResourceExplorer

Parámetros

resourceProvider

ResourceProvider

Proveedor de recursos que se va a agregar.

Devoluciones

ResourceExplorer

Explorador de recursos para que pueda llamar fluidamente a varios métodos en el explorador de recursos.

addResourceType(string)

Agregue un tipo de recurso al conjunto de tipos de recursos.

function addResourceType(type: string)

Parámetros

type

string

Tipo de recurso.

buildType<T, C>(string, C)

Tipo de compilación para $kind dados a partir de la configuración.

function buildType<T, C>(kind: string, config: C): T

Parámetros

kind

string

$kind.

config

C

Objeto de configuración de origen.

Devoluciones

T

Objeto creado por instancias.

getResource(string)

Obtiene el recurso por identificador.

function getResource(id: string): Resource

Parámetros

id

string

Identificador de recurso.

Devoluciones

Resource

El recurso o undefined si no se encuentra.

getResources(string)

Obtiene recursos de una extensión de tipo determinada.

function getResources(fileExtension: string): Resource[]

Parámetros

fileExtension

string

Filtro de extensión de archivo.

Devoluciones

Resource[]

Los recursos.

loadType<T>(Resource)

Tipo de carga desde el recurso

function loadType<T>(resource: Resource): T

Parámetros

resource

Resource

Identificador de recurso al que se va a enlazar.

Devoluciones

T

Tipo creado a partir del recurso.

loadType<T>(string)

Tipo de carga desde el recurso

function loadType<T>(resourceId: string): T

Parámetros

resourceId

string

Identificador de recurso al que se va a enlazar.

Devoluciones

T

Tipo creado a partir del recurso

refresh()

Vuelva a cargar los datos almacenados en caché.

function refresh()

registerType<T>(string, Newable<T>, CustomDeserializer<T, Record<string, unknown>>)

Registre un tipo declarativo con el sistema del cargador de recursos.

function registerType<T>(kind: string, type: Newable<T>, loader?: CustomDeserializer<T, Record<string, unknown>>): ResourceExplorer

Parámetros

kind

string

Nombre $kind que se va a asignar a este tipo.

type

Newable<T>

Tipo de objeto que se va a crear.

loader

CustomDeserializer<T, Record<string, unknown>>

Deserializador personalizado opcional.

Devoluciones

ResourceExplorer

Explorador de recursos para varias llamadas de estilo fluido.