Class Screens

Index

Constructors

constructor

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

Properties

`Private` client

client: Client

Methods

addFieldToDefaultScreen

addFieldToDefaultScreen<T>(parameters, callback): 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 | Version3.Version3Parameters.AddFieldToDefaultScreen
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:126
addFieldToDefaultScreen<T>(parameters, callback?): 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 | Version3.Version3Parameters.AddFieldToDefaultScreen
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:136

createScreen

createScreen<T>(parameters, callback): Promise<void>
Creates a screen with a default field tab.

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

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

deleteScreen

deleteScreen<T>(parameters, callback): 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 | Version3.Version3Parameters.DeleteScreen
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:189
deleteScreen<T>(parameters, callback?): 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 | Version3.Version3Parameters.DeleteScreen
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:195

getAvailableScreenFields

getAvailableScreenFields<T>(parameters, callback): Promise<void>
Returns the fields that can be added to a tab on a screen.

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

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

getScreens

getScreens<T>(parameters, callback): 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 = Version3.Version3Models.PageScreen
Parameters
- parameters: undefined | Version3.Version3Parameters.GetScreens
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screens.ts:58
getScreens<T>(parameters?, callback?): 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 = Version3.Version3Models.PageScreen
Parameters
- Optional parameters: Version3.Version3Parameters.GetScreens
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/screens.ts:69

getScreensForField

getScreensForField<T>(parameters, callback): Promise<void>
Returns a paginated list of the screens a field is used in.

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

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

updateScreen

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

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

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

Class Screens

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Version3.Screens

Properties

Private client

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

Member Visibility

Theme

On This Page

`Private` client