com.atlassian.servicedesk.api.request.participant

Interface RequestParticipantService

@PublicApi
public interface RequestParticipantService

Used to perform actions on ApplicationUser who participates in a CustomerRequest

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>>	addRequestParticipants(com.atlassian.jira.user.ApplicationUser user, RequestParticipantUpdateParameters requestParticipantUpdateParameters) Add a list of ApplicationUser as participant to a given CustomerRequest.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>>	getRequestParticipants(com.atlassian.jira.user.ApplicationUser user, RequestParticipantQuery requestParticipantQuery) Get a page of ApplicationUser who satisfy the query parameters
RequestParticipantQuery.Builder	newQueryBuilder()
RequestParticipantUpdateParameters.Builder	newUpdateBuilder()
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>>	removeRequestParticipants(com.atlassian.jira.user.ApplicationUser user, RequestParticipantUpdateParameters requestParticipantUpdateParameters) Remove a list ApplicationUser as participant from a given CustomerRequest.

Method Detail

newQueryBuilder

RequestParticipantQuery.Builder newQueryBuilder()

Returns:

a new RequestParticipantQuery.Builder instance to build RequestParticipantQuery

getRequestParticipants

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>> getRequestParticipants(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                              RequestParticipantQuery requestParticipantQuery)

Get a page of ApplicationUser who satisfy the query parameters

Parameters:

user - the user executing the request

requestParticipantQuery - the query parameter

Returns:

a page of ApplicationUser if success, or AnError if failure

newUpdateBuilder

RequestParticipantUpdateParameters.Builder newUpdateBuilder()

Returns:

a new RequestParticipantUpdateParameters.Builder instance to build RequestParticipantUpdateParameters

addRequestParticipants

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>> addRequestParticipants(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                              RequestParticipantUpdateParameters requestParticipantUpdateParameters)

Add a list of ApplicationUser as participant to a given CustomerRequest. This method will add as many participants as possible from the provided list (duplication is checked)

Parameters:

user - the ApplicationUser executing the request

requestParticipantUpdateParameters - the update parameters

Returns:

the updated participant list

removeRequestParticipants

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.user.ApplicationUser>> removeRequestParticipants(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                                 RequestParticipantUpdateParameters requestParticipantUpdateParameters)

Remove a list ApplicationUser as participant from a given CustomerRequest. If a provided user is a participant, then he will be removed from the request. If the user is not a participant, AnError will be returned

Parameters:

user - the ApplicationUser executing the request

requestParticipantUpdateParameters - the update parameters

Returns:

the updated participant list