Class AnnouncementBanner

Index

Constructors

Methods

getBanner setBanner

Constructors

constructor

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

Methods

getBanner

getBanner<T = Version3Models.AnnouncementBannerConfiguration>(
callback: Callback<T>,
): Promise<void>
Returns the current announcement banner configuration.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.AnnouncementBannerConfiguration
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/announcementBanner.ts:16
getBanner<T = Version3Models.AnnouncementBannerConfiguration>(
callback?: undefined,
): Promise<T>
Returns the current announcement banner configuration.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.AnnouncementBannerConfiguration
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/announcementBanner.ts:23

setBanner

setBanner<T = void>(
parameters: undefined | Version3Parameters.SetBanner,
callback: Callback<T>,
): Promise<void>
Updates the announcement banner configuration.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: undefined | Version3Parameters.SetBanner
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/announcementBanner.ts:39
setBanner<T = void>(
parameters?: Version3Parameters.SetBanner,
callback?: undefined,
): Promise<T>
Updates the announcement banner configuration.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- Optionalparameters: Version3Parameters.SetBanner
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/announcementBanner.ts:46