Class Screens

Index

Constructors

constructor

Methods

addFieldToDefaultScreen createScreen deleteScreen getAvailableScreenFields getScreens getScreensForField updateScreen

Constructors

constructor

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

Methods

addFieldToDefaultScreen

addFieldToDefaultScreen<T = unknown>(
parameters: string | Version3Parameters.AddFieldToDefaultScreen,
callback: Callback<T>,
): Promise<void>
Adds a field to the default tab of the default screen.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: string | Version3Parameters.AddFieldToDefaultScreen
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:126
addFieldToDefaultScreen<T = unknown>(
parameters: string | Version3Parameters.AddFieldToDefaultScreen,
callback?: undefined,
): Promise<T>
Adds a field to the default tab of the default screen.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: string | Version3Parameters.AddFieldToDefaultScreen
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:136

createScreen

createScreen<T = Version3Models.Screen>(
parameters: Version3Parameters.CreateScreen,
callback: Callback<T>,
): Promise<void>
Creates a screen with a default field tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Screen
Parameters
- parameters: Version3Parameters.CreateScreen
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:96
createScreen<T = Version3Models.Screen>(
parameters: Version3Parameters.CreateScreen,
callback?: undefined,
): Promise<T>
Creates a screen with a default field tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Screen
Parameters
- parameters: Version3Parameters.CreateScreen
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:103

deleteScreen

deleteScreen<T = void>(
parameters: string | Version3Parameters.DeleteScreen,
callback: Callback<T>,
): Promise<void>
Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.

Only screens used in classic projects can be deleted.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteScreen
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:189
deleteScreen<T = void>(
parameters: string | Version3Parameters.DeleteScreen,
callback?: undefined,
): Promise<T>
Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.

Only screens used in classic projects can be deleted.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteScreen
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:195

getAvailableScreenFields

getAvailableScreenFields<T = Version3Models.ScreenableField[]>(
parameters: string | Version3Parameters.GetAvailableScreenFields,
callback: Callback<T>,
): Promise<void>
Returns the fields that can be added to a tab on a screen.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableField[]
Parameters
- parameters: string | Version3Parameters.GetAvailableScreenFields
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:216
getAvailableScreenFields<T = Version3Models.ScreenableField[]>(
parameters: string | Version3Parameters.GetAvailableScreenFields,
callback?: undefined,
): Promise<T>
Returns the fields that can be added to a tab on a screen.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableField[]
Parameters
- parameters: string | Version3Parameters.GetAvailableScreenFields
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:226

getScreens

getScreens<T = Version3Models.PageScreen>(
parameters: undefined | Version3Parameters.GetScreens,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of all screens or those specified by one or more screen IDs.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageScreen
Parameters
- parameters: undefined | Version3Parameters.GetScreens
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:58
getScreens<T = Version3Models.PageScreen>(
parameters?: Version3Parameters.GetScreens,
callback?: undefined,
): Promise<T>
Returns a paginated list of all screens or those specified by one or more screen IDs.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageScreen
Parameters
- Optionalparameters: Version3Parameters.GetScreens
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:69

getScreensForField

getScreensForField<T = Version3Models.PageScreenWithTab>(
parameters: string | Version3Parameters.GetScreensForField,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of the screens a field is used in.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageScreenWithTab
Parameters
- parameters: string | Version3Parameters.GetScreensForField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:17
getScreensForField<T = Version3Models.PageScreenWithTab>(
parameters: string | Version3Parameters.GetScreensForField,
callback?: undefined,
): Promise<T>
Returns a paginated list of the screens a field is used in.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageScreenWithTab
Parameters
- parameters: string | Version3Parameters.GetScreensForField
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:28

updateScreen

updateScreen<T = Version3Models.Screen>(
parameters: Version3Parameters.UpdateScreen,
callback: Callback<T>,
): Promise<void>
Updates a screen. Only screens used in classic projects can be updated.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Screen
Parameters
- parameters: Version3Parameters.UpdateScreen
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:160
updateScreen<T = Version3Models.Screen>(
parameters: Version3Parameters.UpdateScreen,
callback?: undefined,
): Promise<T>
Updates a screen. Only screens used in classic projects can be updated.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Screen
Parameters
- parameters: Version3Parameters.UpdateScreen
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:167

Class Screens

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Screens

Methods

addFieldToDefaultScreen

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createScreen

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteScreen

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAvailableScreenFields

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getScreens

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getScreensForField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateScreen

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page