Class DynamicModules

Index

Constructors

Methods

getModules registerModules removeModules

Constructors

constructor

new DynamicModules(client: Client): Version3.DynamicModules
Parameters
- client: Client
Returns Version3.DynamicModules
- Defined in src/version3/dynamicModules.ts:8

Methods

getModules

getModules<T = Version3Models.ConnectModules>(
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 = Version3Models.ConnectModules
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/dynamicModules.ts:16
getModules<T = Version3Models.ConnectModules>(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 = Version3Models.ConnectModules
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/dynamicModules.ts:23

registerModules

registerModules<T = unknown>(
parameters: undefined | Version3Parameters.RegisterModules,
callback: Callback<T>,
): Promise<void>
Registers a list of modules.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = unknown
Parameters
- parameters: undefined | Version3Parameters.RegisterModules
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/dynamicModules.ts:39
registerModules<T = unknown>(
parameters?: Version3Parameters.RegisterModules,
callback?: undefined,
): Promise<T>
Registers a list of modules.

Permissions required: Only Connect apps can make this request.
Type Parameters
- T = unknown
Parameters
- Optionalparameters: Version3Parameters.RegisterModules
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/dynamicModules.ts:49

removeModules

removeModules<T = void>(
parameters: undefined | Version3Parameters.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: undefined | Version3Parameters.RemoveModules
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/dynamicModules.ts:71
removeModules<T = void>(
parameters?: Version3Parameters.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
- Optionalparameters: Version3Parameters.RemoveModules
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/dynamicModules.ts:78