Class ScreenTabFields

Index

Constructors

constructor

Methods

addScreenTabField getAllScreenTabFields moveScreenTabField removeScreenTabField

Constructors

constructor

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

Methods

addScreenTabField

addScreenTabField<T = Version3Models.ScreenableField>(
parameters: Version3Parameters.AddScreenTabField,
callback: Callback<T>,
): Promise<void>
Adds a field to a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableField
Parameters
- parameters: Version3Parameters.AddScreenTabField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabFields.ts:59
addScreenTabField<T = Version3Models.ScreenableField>(
parameters: Version3Parameters.AddScreenTabField,
callback?: undefined,
): Promise<T>
Adds a field to a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ScreenableField
Parameters
- parameters: Version3Parameters.AddScreenTabField
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenTabFields.ts:69

getAllScreenTabFields

getAllScreenTabFields<T = Version3Models.ScreenableField[]>(
parameters: Version3Parameters.GetAllScreenTabFields,
callback: Callback<T>,
): Promise<void>
Returns all fields for a screen tab.

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.ScreenableField[]
Parameters
- parameters: Version3Parameters.GetAllScreenTabFields
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabFields.ts:20
getAllScreenTabFields<T = Version3Models.ScreenableField[]>(
parameters: Version3Parameters.GetAllScreenTabFields,
callback?: undefined,
): Promise<T>
Returns all fields for a screen tab.

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.ScreenableField[]
Parameters
- parameters: Version3Parameters.GetAllScreenTabFields
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/screenTabFields.ts:34

moveScreenTabField

moveScreenTabField<T = void>(
parameters: Version3Parameters.MoveScreenTabField,
callback: Callback<T>,
): Promise<void>
Moves a screen tab field.

If after and position are provided in the request, position is ignored.

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

If after and position are provided in the request, position is ignored.

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

removeScreenTabField

removeScreenTabField<T = void>(
parameters: Version3Parameters.RemoveScreenTabField,
callback: Callback<T>,
): Promise<void>
Removes a field from a screen tab.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveScreenTabField
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/screenTabFields.ts:94
removeScreenTabField<T = void>(
parameters: Version3Parameters.RemoveScreenTabField,
callback?: undefined,
): Promise<T>
Removes a field from a screen tab.

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

Class ScreenTabFields

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ScreenTabFields

Methods

addScreenTabField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllScreenTabFields

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

moveScreenTabField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeScreenTabField

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page