Class UserNavProperties

Index

Constructors

Methods

getUserNavProperty setUserNavProperty

Constructors

constructor

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

Methods

getUserNavProperty

getUserNavProperty<T = Version3Models.UserNavProperty>(
parameters: Version3Parameters.GetUserNavProperty,
callback: Callback<T>,
): Promise<void>
Returns the value of a user nav preference.

Note: This operation fetches the property key value directly from RbacClient.

Permissions required:
- Administer Jira global permission, to get a property from any user.
- Access to Jira, to get a property from the calling user's record.
Type Parameters
- T = Version3Models.UserNavProperty
Parameters
- parameters: Version3Parameters.GetUserNavProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/userNavProperties.ts:20
getUserNavProperty<T = Version3Models.UserNavProperty>(
parameters: Version3Parameters.GetUserNavProperty,
callback?: undefined,
): Promise<T>
Returns the value of a user nav preference.

Note: This operation fetches the property key value directly from RbacClient.

Permissions required:
- Administer Jira global permission, to get a property from any user.
- Access to Jira, to get a property from the calling user's record.
Type Parameters
- T = Version3Models.UserNavProperty
Parameters
- parameters: Version3Parameters.GetUserNavProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/userNavProperties.ts:34

setUserNavProperty

setUserNavProperty<T = unknown>(
parameters: Version3Parameters.SetUserNavProperty,
callback: Callback<T>,
): Promise<void>
Sets the value of a Nav4 preference. Use this resource to store Nav4 preference data against a user in the Identity service.

Permissions required:
- Administer Jira global permission, to set a property on any user.
- Access to Jira, to set a property on the calling user's record.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetUserNavProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/userNavProperties.ts:62
setUserNavProperty<T = unknown>(
parameters: Version3Parameters.SetUserNavProperty,
callback?: undefined,
): Promise<T>
Sets the value of a Nav4 preference. Use this resource to store Nav4 preference data against a user in the Identity service.

Permissions required:
- Administer Jira global permission, to set a property on any user.
- Access to Jira, to set a property on the calling user's record.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetUserNavProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/userNavProperties.ts:75