Class ScreenTabs

Index

Constructors

constructor

Methods

addScreenTab deleteScreenTab getAllScreenTabs getBulkScreenTabs moveScreenTab renameScreenTab

Constructors

constructor

new ScreenTabs(client: Client): Version3.ScreenTabs
Parameters
- client: Client
Returns Version3.ScreenTabs
- Defined in src/version3/screenTabs.ts:9

Methods

addScreenTab

addScreenTab<T = Version3Models.ScreenableTab>(
parameters: Version3Parameters.AddScreenTab,
callback: Callback<T>,
): Promise<void>
Creates a tab for a screen.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableTab
Parameters
- parameters: Version3Parameters.AddScreenTab
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabs.ts:99
addScreenTab<T = Version3Models.ScreenableTab>(
parameters: Version3Parameters.AddScreenTab,
callback?: undefined,
): Promise<T>
Creates a tab for a screen.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableTab
Parameters
- parameters: Version3Parameters.AddScreenTab
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenTabs.ts:109

deleteScreenTab

deleteScreenTab<T = void>(
parameters: Version3Parameters.DeleteScreenTab,
callback: Callback<T>,
): Promise<void>
Deletes a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteScreenTab
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabs.ts:165
deleteScreenTab<T = void>(
parameters: Version3Parameters.DeleteScreenTab,
callback?: undefined,
): Promise<T>
Deletes a screen tab.

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

getAllScreenTabs

getAllScreenTabs<T = Version3Models.ScreenableTab[]>(
parameters: string | Version3Parameters.GetAllScreenTabs,
callback: Callback<T>,
): Promise<void>
Returns the list of tabs for a screen.

Permissions required:
- Administer Jira global permission.
- Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
Type Parameters
- T = Version3Models.ScreenableTab[]
Parameters
- parameters: string | Version3Parameters.GetAllScreenTabs
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabs.ts:58
getAllScreenTabs<T = Version3Models.ScreenableTab[]>(
parameters: string | Version3Parameters.GetAllScreenTabs,
callback?: undefined,
): Promise<T>
Returns the list of tabs for a screen.

Permissions required:
- Administer Jira global permission.
- Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
Type Parameters
- T = Version3Models.ScreenableTab[]
Parameters
- parameters: string | Version3Parameters.GetAllScreenTabs
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenTabs.ts:72

getBulkScreenTabs

getBulkScreenTabs<T = unknown>(
parameters: undefined | Version3Parameters.GetBulkScreenTabs,
callback: Callback<T>,
): Promise<void>
Returns the list of tabs for a bulk of screens.

Permissions required:
- Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: undefined | Version3Parameters.GetBulkScreenTabs
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabs.ts:18
getBulkScreenTabs<T = unknown>(
parameters?: Version3Parameters.GetBulkScreenTabs,
callback?: undefined,
): Promise<T>
Returns the list of tabs for a bulk of screens.

Permissions required:
- Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- Optionalparameters: Version3Parameters.GetBulkScreenTabs
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenTabs.ts:29

moveScreenTab

moveScreenTab<T = void>(
parameters: Version3Parameters.MoveScreenTab,
callback: Callback<T>,
): Promise<void>
Moves a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.MoveScreenTab
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabs.ts:188
moveScreenTab<T = void>(
parameters: Version3Parameters.MoveScreenTab,
callback?: undefined,
): Promise<T>
Moves a screen tab.

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

renameScreenTab

renameScreenTab<T = Version3Models.ScreenableTab>(
parameters: Version3Parameters.RenameScreenTab,
callback: Callback<T>,
): Promise<void>
Updates the name of a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableTab
Parameters
- parameters: Version3Parameters.RenameScreenTab
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabs.ts:132
renameScreenTab<T = Version3Models.ScreenableTab>(
parameters: Version3Parameters.RenameScreenTab,
callback?: undefined,
): Promise<T>
Updates the name of a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableTab
Parameters
- parameters: Version3Parameters.RenameScreenTab
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenTabs.ts:142

Class ScreenTabs

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ScreenTabs

Methods

addScreenTab

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteScreenTab

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllScreenTabs

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getBulkScreenTabs

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

moveScreenTab

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

renameScreenTab

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page