Class ProjectCategories

Index

Constructors

constructor

Methods

createProjectCategory getAllProjectCategories getProjectCategoryById removeProjectCategory updateProjectCategory

Constructors

constructor

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

Methods

createProjectCategory

createProjectCategory<T = Version3Models.ProjectCategory>(
parameters: Version3Parameters.CreateProjectCategory,
callback: Callback<T>,
): Promise<void>
Creates a project category.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ProjectCategory
Parameters
- parameters: Version3Parameters.CreateProjectCategory
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectCategories.ts:39
createProjectCategory<T = Version3Models.ProjectCategory>(
parameters: Version3Parameters.CreateProjectCategory,
callback?: undefined,
): Promise<T>
Creates a project category.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.ProjectCategory
Parameters
- parameters: Version3Parameters.CreateProjectCategory
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectCategories.ts:49

getAllProjectCategories

getAllProjectCategories<T = Version3Models.ProjectCategory[]>(
callback: Callback<T>,
): Promise<void>
Returns all project categories.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.ProjectCategory[]
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectCategories.ts:16
getAllProjectCategories<T = Version3Models.ProjectCategory[]>(
callback?: undefined,
): Promise<T>
Returns all project categories.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.ProjectCategory[]
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectCategories.ts:23

getProjectCategoryById

getProjectCategoryById<T = Version3Models.ProjectCategory>(
parameters: Version3Parameters.GetProjectCategoryById,
callback: Callback<T>,
): Promise<void>
Returns a project category.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.ProjectCategory
Parameters
- parameters: Version3Parameters.GetProjectCategoryById
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectCategories.ts:77
getProjectCategoryById<T = Version3Models.ProjectCategory>(
parameters: Version3Parameters.GetProjectCategoryById,
callback?: undefined,
): Promise<T>
Returns a project category.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.ProjectCategory
Parameters
- parameters: Version3Parameters.GetProjectCategoryById
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectCategories.ts:87

removeProjectCategory

removeProjectCategory<T = void>(
parameters: Version3Parameters.RemoveProjectCategory,
callback: Callback<T>,
): Promise<void>
Deletes a project category.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveProjectCategory
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectCategories.ts:145
removeProjectCategory<T = void>(
parameters: Version3Parameters.RemoveProjectCategory,
callback?: undefined,
): Promise<T>
Deletes a project category.

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

updateProjectCategory

updateProjectCategory<T = Version3Models.UpdatedProjectCategory>(
parameters: Version3Parameters.UpdateProjectCategory,
callback: Callback<T>,
): Promise<void>
Updates a project category.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.UpdatedProjectCategory
Parameters
- parameters: Version3Parameters.UpdateProjectCategory
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectCategories.ts:109
updateProjectCategory<T = Version3Models.UpdatedProjectCategory>(
parameters: Version3Parameters.UpdateProjectCategory,
callback?: undefined,
): Promise<T>
Updates a project category.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.UpdatedProjectCategory
Parameters
- parameters: Version3Parameters.UpdateProjectCategory
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectCategories.ts:119

Class ProjectCategories

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ProjectCategories

Methods

createProjectCategory

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllProjectCategories

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectCategoryById

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeProjectCategory

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateProjectCategory

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page