Class TimeTracking

Index

Constructors

Methods

getAvailableTimeTrackingImplementations getSelectedTimeTrackingImplementation getSharedTimeTrackingConfiguration selectTimeTrackingImplementation setSharedTimeTrackingConfiguration

Constructors

constructor

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

Methods

getAvailableTimeTrackingImplementations

getAvailableTimeTrackingImplementations<
T = Version3Models.TimeTrackingProvider[],
>(
callback: Callback<T>,
): Promise<void>
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.TimeTrackingProvider[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/timeTracking.ts:81
getAvailableTimeTrackingImplementations<
T = Version3Models.TimeTrackingProvider[],
>(
callback?: undefined,
): Promise<T>
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.TimeTrackingProvider[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/timeTracking.ts:93

getSelectedTimeTrackingImplementation

getSelectedTimeTrackingImplementation<T = void>(
callback: Callback<T>,
): Promise<void>
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/timeTracking.ts:17
getSelectedTimeTrackingImplementation<T = void>(
callback?: undefined,
): Promise<T>
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/timeTracking.ts:25

getSharedTimeTrackingConfiguration

getSharedTimeTrackingConfiguration<T = Version3Models.TimeTrackingConfiguration>(
callback: Callback<T>,
): Promise<void>
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.TimeTrackingConfiguration
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/timeTracking.ts:112
getSharedTimeTrackingConfiguration<T = Version3Models.TimeTrackingConfiguration>(
callback?: undefined,
): Promise<T>
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.TimeTrackingConfiguration
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/timeTracking.ts:120

selectTimeTrackingImplementation

selectTimeTrackingImplementation<T = void>(
    parameters:
        | undefined
        | Version3Parameters.SelectTimeTrackingImplementation,
    callback: Callback<T>,
): Promise<void>
Selects a time tracking provider.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: undefined | Version3Parameters.SelectTimeTrackingImplementation
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/timeTracking.ts:41
selectTimeTrackingImplementation<T = void>(
parameters?: Version3Parameters.SelectTimeTrackingImplementation,
callback?: undefined,
): Promise<T>
Selects a time tracking provider.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- Optionalparameters: Version3Parameters.SelectTimeTrackingImplementation
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/timeTracking.ts:51

setSharedTimeTrackingConfiguration

setSharedTimeTrackingConfiguration<T = Version3Models.TimeTrackingConfiguration>(
parameters: Version3Parameters.SetSharedTimeTrackingConfiguration,
callback: Callback<T>,
): Promise<void>
Sets the time tracking settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.TimeTrackingConfiguration
Parameters
- parameters: Version3Parameters.SetSharedTimeTrackingConfiguration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/timeTracking.ts:138
setSharedTimeTrackingConfiguration<T = Version3Models.TimeTrackingConfiguration>(
parameters: Version3Parameters.SetSharedTimeTrackingConfiguration,
callback?: undefined,
): Promise<T>
Sets the time tracking settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.TimeTrackingConfiguration
Parameters
- parameters: Version3Parameters.SetSharedTimeTrackingConfiguration
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/timeTracking.ts:148

Class TimeTracking

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.TimeTracking

Methods

getAvailableTimeTrackingImplementations

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSelectedTimeTrackingImplementation

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSharedTimeTrackingConfiguration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

selectTimeTrackingImplementation

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setSharedTimeTrackingConfiguration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page