Class DynamicModules

Index

Constructors

Methods

getModules registerModules removeModules

Constructors

constructor

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

Methods

getModules

getModules<T = unknown>(callback: Callback<T>): 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 src/api/dynamicModules.ts:14
getModules<T = unknown>(callback?: undefined): 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
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/dynamicModules.ts:20

registerModules

registerModules<T = unknown>(
parameters: undefined | ConnectModules,
callback: Callback<T>,
): 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 src/api/dynamicModules.ts:36
registerModules<T = unknown>(
parameters?: ConnectModules,
callback?: undefined,
): 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
- Optionalparameters: ConnectModules
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/dynamicModules.ts:46

removeModules

removeModules<T = void>(
parameters: RemoveModules,
callback: Callback<T>,
): 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 src/api/dynamicModules.ts:65
removeModules<T = void>(
parameters: RemoveModules,
callback?: undefined,
): 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
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/dynamicModules.ts:71