Function: setBanner()
ts
function setBanner(
client,
parameters,
options?
): Promise<void>;Defined in: src/cloud/api/announcementBanner.ts:31
Updates the announcement banner configuration.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { isDismissible?: boolean; isEnabled?: boolean; message?: string; visibility?: string; } | - |
parameters.isDismissible? | boolean | Flag indicating if the announcement banner can be dismissed by the user. |
parameters.isEnabled? | boolean | Flag indicating if the announcement banner is enabled or not. |
parameters.message? | string | The text on the announcement banner. |
parameters.visibility? | string | Visibility of the announcement banner. Can be public or private. |
options? | RequestOptions | - |
Returns
Promise<void>