Class ScreenSchemes

Index

Constructors

constructor

Methods

createScreenScheme deleteScreenScheme getScreenSchemes updateScreenScheme

Constructors

constructor

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

Methods

createScreenScheme

createScreenScheme<T = Version3Models.ScreenSchemeId>(
parameters: string | Version3Parameters.CreateScreenScheme,
callback: Callback<T>,
): Promise<void>
Creates a screen scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenSchemeId
Parameters
- parameters: string | Version3Parameters.CreateScreenScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenSchemes.ts:62
createScreenScheme<T = Version3Models.ScreenSchemeId>(
parameters: string | Version3Parameters.CreateScreenScheme,
callback?: undefined,
): Promise<T>
Creates a screen scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenSchemeId
Parameters
- parameters: string | Version3Parameters.CreateScreenScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenSchemes.ts:72

deleteScreenScheme

deleteScreenScheme<T = void>(
parameters: string | Version3Parameters.DeleteScreenScheme,
callback: Callback<T>,
): Promise<void>
Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

Only screens schemes used in classic projects can be deleted.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteScreenScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenSchemes.ts:134
deleteScreenScheme<T = void>(
parameters: string | Version3Parameters.DeleteScreenScheme,
callback?: undefined,
): Promise<T>
Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

Only screens schemes used in classic projects can be deleted.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteScreenScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenSchemes.ts:146

getScreenSchemes

getScreenSchemes<T = Version3Models.PageScreenScheme>(
parameters: undefined | Version3Parameters.GetScreenSchemes,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageScreenScheme
Parameters
- parameters: undefined | Version3Parameters.GetScreenSchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenSchemes.ts:19
getScreenSchemes<T = Version3Models.PageScreenScheme>(
parameters?: Version3Parameters.GetScreenSchemes,
callback?: undefined,
): Promise<T>
Returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageScreenScheme
Parameters
- Optionalparameters: Version3Parameters.GetScreenSchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenSchemes.ts:32

updateScreenScheme

updateScreenScheme<T = void>(
parameters: Version3Parameters.UpdateScreenScheme,
callback: Callback<T>,
): Promise<void>
Updates a screen scheme. Only screen schemes used in classic projects can be updated.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateScreenScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenSchemes.ts:101
updateScreenScheme<T = void>(
parameters: Version3Parameters.UpdateScreenScheme,
callback?: undefined,
): Promise<T>
Updates a screen scheme. Only screen schemes used in classic projects can be updated.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateScreenScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenSchemes.ts:108

Class ScreenSchemes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ScreenSchemes

Methods

createScreenScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteScreenScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getScreenSchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateScreenScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page