Class FilterSharing

Index

Constructors

Methods

addSharePermission deleteSharePermission getDefaultShareScope getSharePermission getSharePermissions setDefaultShareScope

Constructors

constructor

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

Methods

addSharePermission

addSharePermission<T = Version3Models.SharePermission[]>(
parameters: Version3Parameters.AddSharePermission,
callback: Callback<T>,
): Promise<void>
Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.
Type Parameters
- T = Version3Models.SharePermission[]
Parameters
- parameters: Version3Parameters.AddSharePermission
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/filterSharing.ts:135
addSharePermission<T = Version3Models.SharePermission[]>(
parameters: Version3Parameters.AddSharePermission,
callback?: undefined,
): Promise<T>
Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.
Type Parameters
- T = Version3Models.SharePermission[]
Parameters
- parameters: Version3Parameters.AddSharePermission
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/filterSharing.ts:150

deleteSharePermission

deleteSharePermission<T = void>(
parameters: Version3Parameters.DeleteSharePermission,
callback: Callback<T>,
): Promise<void>
Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteSharePermission
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/filterSharing.ts:233
deleteSharePermission<T = void>(
parameters: Version3Parameters.DeleteSharePermission,
callback?: undefined,
): Promise<T>
Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteSharePermission
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/filterSharing.ts:243

getDefaultShareScope

getDefaultShareScope<T = Version3Models.DefaultShareScope>(
callback: Callback<T>,
): Promise<void>
Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.DefaultShareScope
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/filterSharing.ts:16
getDefaultShareScope<T = Version3Models.DefaultShareScope>(
callback?: undefined,
): Promise<T>
Returns the default sharing settings for new filters and dashboards for a user.

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

getSharePermission

getSharePermission<T = Version3Models.SharePermission>(
parameters: Version3Parameters.GetSharePermission,
callback: Callback<T>,
): Promise<void>
Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, a share permission is only returned for:
- Filters owned by the user.
- Filters shared with a group that the user is a member of.
- Filters shared with a private project that the user has Browse projects project permission for.
- Filters shared with a public project.
- Filters shared with the public.
Type Parameters
- T = Version3Models.SharePermission
Parameters
- parameters: Version3Parameters.GetSharePermission
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/filterSharing.ts:191
getSharePermission<T = Version3Models.SharePermission>(
parameters: Version3Parameters.GetSharePermission,
callback?: undefined,
): Promise<T>
Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, a share permission is only returned for:
- Filters owned by the user.
- Filters shared with a group that the user is a member of.
- Filters shared with a private project that the user has Browse projects project permission for.
- Filters shared with a public project.
- Filters shared with the public.
Type Parameters
- T = Version3Models.SharePermission
Parameters
- parameters: Version3Parameters.GetSharePermission
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/filterSharing.ts:211

getSharePermissions

getSharePermissions<T = Version3Models.SharePermission[]>(
parameters: string | Version3Parameters.GetSharePermissions,
callback: Callback<T>,
): Promise<void>
Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, share permissions are only returned for:
- Filters owned by the user.
- Filters shared with a group that the user is a member of.
- Filters shared with a private project that the user has Browse projects project permission for.
- Filters shared with a public project.
- Filters shared with the public.
Type Parameters
- T = Version3Models.SharePermission[]
Parameters
- parameters: string | Version3Parameters.GetSharePermissions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/filterSharing.ts:86
getSharePermissions<T = Version3Models.SharePermission[]>(
parameters: string | Version3Parameters.GetSharePermissions,
callback?: undefined,
): Promise<T>
Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, share permissions are only returned for:
- Filters owned by the user.
- Filters shared with a group that the user is a member of.
- Filters shared with a private project that the user has Browse projects project permission for.
- Filters shared with a public project.
- Filters shared with the public.
Type Parameters
- T = Version3Models.SharePermission[]
Parameters
- parameters: string | Version3Parameters.GetSharePermissions
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/filterSharing.ts:106

setDefaultShareScope

setDefaultShareScope<T = Version3Models.DefaultShareScope>(
parameters: string | Version3Parameters.SetDefaultShareScope,
callback: Callback<T>,
): Promise<void>
Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.DefaultShareScope
Parameters
- parameters: string | Version3Parameters.SetDefaultShareScope
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/filterSharing.ts:39
setDefaultShareScope<T = Version3Models.DefaultShareScope>(
parameters: string | Version3Parameters.SetDefaultShareScope,
callback?: undefined,
): Promise<T>
Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.DefaultShareScope
Parameters
- parameters: string | Version3Parameters.SetDefaultShareScope
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/filterSharing.ts:49

Class FilterSharing

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.FilterSharing

Methods

addSharePermission

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteSharePermission

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getDefaultShareScope

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSharePermission

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSharePermissions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setDefaultShareScope

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page