Class DynamicModules

Index

Constructors

Properties

Methods

getModules registerModules removeModules

Constructors

constructor

new DynamicModules(client): DynamicModules
Parameters
- client: Client
Returns DynamicModules
- Defined in api/dynamicModules.ts:7

Properties

`Private` client

client: Client

Methods

getModules

getModules<T>(callback): Promise<void>
Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = unknown
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in api/dynamicModules.ts:14
getModules<T>(callback?): Promise<T>
Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = unknown
Parameters
- Optional callback: undefined
Returns Promise<T>
- Defined in api/dynamicModules.ts:20

registerModules

registerModules<T>(parameters, callback): Promise<void>
Registers a list of modules. For the list of modules that support dynamic registration, see Dynamic modules.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = unknown
Parameters
- parameters: undefined | ConnectModules
- callback: Callback<T>
Returns Promise<void>
- Defined in api/dynamicModules.ts:36
registerModules<T>(parameters?, callback?): Promise<T>
Registers a list of modules. For the list of modules that support dynamic registration, see Dynamic modules.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = unknown
Parameters
- Optional parameters: ConnectModules
- Optional callback: undefined
Returns Promise<T>
- Defined in api/dynamicModules.ts:46

removeModules

removeModules<T>(parameters, callback): Promise<void>
Remove all or a list of modules registered by the calling app.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = void
Parameters
- parameters: RemoveModules
- callback: Callback<T>
Returns Promise<void>
- Defined in api/dynamicModules.ts:65
removeModules<T>(parameters, callback?): Promise<T>
Remove all or a list of modules registered by the calling app.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = void
Parameters
- parameters: RemoveModules
- Optional callback: undefined
Returns Promise<T>
- Defined in api/dynamicModules.ts:71

Generated using TypeDoc v0.25.12