Function: updateReadOnlyMode()
ts
function updateReadOnlyMode(
client,
parameters,
options?
): Promise<void>;Defined in: src/server/api/readOnlyMode.ts:26
Enables or disables Jira read-only mode.
Available since Jira Data Center 11.3, and in 10.3 LTS.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { enabled?: boolean; endTime?: string; message?: string; timeZone?: string; } | - |
parameters.enabled? | boolean | Whether read-only mode should be enabled. |
parameters.endTime? | string | The estimated end time as a local date-time (no offset). Omit to leave unchanged; send an empty string to clear it. |
parameters.message? | string | The banner message shown to users while read-only mode is active. Omit to leave it unchanged; send an empty string to reset it to the default. |
parameters.timeZone? | string | The time zone id the estimated end time is expressed in. Omit to leave unchanged; send an empty string to clear it. |
options? | RequestOptions | - |
Returns
Promise<void>