Skip to content

Function: getBanner() ​

ts
function getBanner(client, options?): Promise<{
[key: string]: unknown;
  hashId?: string;
  isDismissible?: boolean;
  isEnabled?: boolean;
  message?: string;
  visibility?: "private" | "public" | string & object;
}>;

Defined in: src/cloud/api/announcementBanner.ts:14

Returns the current announcement banner configuration.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterType
clientClient
options?RequestOptions

Returns ​

Promise<{ [key: string]: unknown; hashId?: string; isDismissible?: boolean; isEnabled?: boolean; message?: string; visibility?: "private" | "public" | string & object; }>