Class AnnouncementBannerService

This resource represents an announcement banner. Use it to retrieve and update banner configuration.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner

Hierarchy

CommonHttpService
- AnnouncementBannerService

Index

Constructors

Methods

getBanner setBanner initialize

Constructors

constructor

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

Methods

getBanner

getBanner(): Promise<AnnouncementBannerConfiguration>
Returns the current announcement banner configuration.

Permissions required: Administer Jira global permission.

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

example:
```
{
  "hashId": "9HN2FJK9DM8BHRWERVW3RRTGDJ4G4D5C",
  "isDismissible": false,
  "isEnabled": true,
  "message": "This is a public, enabled, non-dismissible banner, set using the API",
  "visibility": "public"
}
```
Path
GET /rest/api/3/announcementBanner

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner#api-rest-api-3-announcementbanner-get

setBanner

setBanner(params): Promise<void>
Updates the announcement banner configuration.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  announcementBannerConfigurationUpdate: AnnouncementBannerConfigurationUpdate;
  }
  - announcementBannerConfigurationUpdate: AnnouncementBannerConfigurationUpdate
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/announcementBanner

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner#api-rest-api-3-announcementbanner-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize