Class DynamicModulesService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules

Hierarchy

CommonHttpService
- DynamicModulesService

Index

Constructors

Methods

getModules registerModules removeModules initialize

Constructors

constructor

new DynamicModulesService(getClientInstance): DynamicModulesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns DynamicModulesService
Inherited from CommonHttpService.constructor

Methods

getModules

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

Permissions required: Only Connect apps can make this request.

Returns Promise<Blob>
Returned if the request is successful.

Path
GET /atlassian-connect/1/app/module/dynamic

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules#api-atlassian-connect-1-app-module-dynamic-get

registerModules

registerModules(params): 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.
Parameters
- params: {
  connectModules: ConnectModules;
  mediaType: string;
  }
  - connectModules: ConnectModules
  - mediaType: string
Returns Promise<void>
Path
POST /atlassian-connect/1/app/module/dynamic

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules#api-atlassian-connect-1-app-module-dynamic-post

removeModules

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

Permissions required: Only Connect apps can make this request.
Parameters
- params: {
  moduleKey: string[];
  }
  - moduleKey: string[]
    The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored.
Returns Promise<void>
Path
DELETE /atlassian-connect/1/app/module/dynamic

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules#api-atlassian-connect-1-app-module-dynamic-delete

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize