org.everit.atlassian.restclient.jiracloud.v2.api

Class FilterSharingApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.FilterSharingApi

public class FilterSharingApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FilterSharingApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<SharePermission>>	addSharePermission(Long id, SharePermissionInputBean sharePermissionInputBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add share permission Add a share permissions to a filter.
io.reactivex.Completable	deleteSharePermission(Long id, Long permissionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete share permission Deletes a share permission from a filter.
io.reactivex.Single<DefaultShareScope>	getDefaultShareScope(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get default share scope Returns the default sharing settings for new filters and dashboards for a user.
io.reactivex.Single<SharePermission>	getSharePermission(Long id, Long permissionId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get share permission Returns a share permission for a filter.
io.reactivex.Single<List<SharePermission>>	getSharePermissions(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get share permissions Returns the share permissions for a filter.
io.reactivex.Single<DefaultShareScope>	setDefaultShareScope(DefaultShareScope defaultShareScope, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set default share scope Sets the default sharing for new filters and dashboards for a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterSharingApi

public FilterSharingApi(org.everit.http.restclient.RestClient restClient)

Method Detail

addSharePermission

public io.reactivex.Single<List<SharePermission>> addSharePermission(Long id,
                                                                     SharePermissionInputBean sharePermissionInputBean,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add share permission 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](#api-rest-api-2-filter-id-put). **[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter.

Parameters:

id - The ID of the filter. (required)

sharePermissionInputBean - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<SharePermission>>

deleteSharePermission

public io.reactivex.Completable deleteSharePermission(Long id,
                                                      Long permissionId,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete share permission Deletes a share permission from a filter. **[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter.

Parameters:

id - The ID of the filter. (required)

permissionId - The ID of the share permission. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getDefaultShareScope

public io.reactivex.Single<DefaultShareScope> getDefaultShareScope(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get default share scope Returns the default sharing settings for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<DefaultShareScope>

getSharePermission

public io.reactivex.Single<SharePermission> getSharePermission(Long id,
                                                               Long permissionId,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get share permission 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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public.

Parameters:

id - The ID of the filter. (required)

permissionId - The ID of the share permission. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<SharePermission>

getSharePermissions

public io.reactivex.Single<List<SharePermission>> getSharePermissions(Long id,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get share permissions 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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public.

Parameters:

id - The ID of the filter. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<SharePermission>>

setDefaultShareScope

public io.reactivex.Single<DefaultShareScope> setDefaultShareScope(DefaultShareScope defaultShareScope,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set default share scope Sets the default sharing for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters:

defaultShareScope - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<DefaultShareScope>