Package com.atlassian.confluence.api.service.people

Interface PersonService

All Known Implementing Classes:

PersonServiceImpl

@ExperimentalApi
public interface PersonService

Provides READ operation on Persons.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PersonService.PersonFinder	A finder for locating persons.
static interface	PersonService.PersonSearcher	A searcher for finding people based on a search term.
static interface	PersonService.SinglePersonFetcher	only here so that the remote person service can proxy it.
static interface	PersonService.Validator	Provides methods for validating the view method.

Method Summary

Modifier and Type	Method	Description
LongTaskSubmission	delete(Person personToDelete)	Delete the given person.
PersonService.PersonFinder	find(Expansion... expansions)	Create a person finder to locate persons Restrictions can be applied to the finder using the appropriate withFoo() method
Person	getCurrentUser(Expansion... expansions)	Get the currently logged in user
PersonService.PersonSearcher	search()	Create a person searcher to find people matching search criteria For given search category and/or criteria, return all People matching the supplied criteria.
PersonService.Validator	validator()	Get the validator of the Person Service.

Method Detail

getCurrentUser

Person getCurrentUser(Expansion... expansions)

Get the currently logged in user

Since:

5.9

find

PersonService.PersonFinder find(Expansion... expansions)

Create a person finder to locate persons Restrictions can be applied to the finder using the appropriate withFoo() method

For example:

 personService.find()
      .withKey("DEV")
      .fetchOne()
 
 

Returns:

a new PersonFinder

delete

LongTaskSubmission delete(Person personToDelete)

Delete the given person.

The deletion happens asynchronously so a LongTaskSubmission is returned, that can be used to track progress.

Parameters:

personToDelete - the person to delete

Returns:

a LongTaskSubmission describing the user deletion operation

Since:

6.13.0

search

PersonService.PersonSearcher search()

Create a person searcher to find people matching search criteria For given search category and/or criteria, return all People matching the supplied criteria.

For example:

 personService.search()
      .forUnsyncedUsers("joe")
      .fetchMany(..)
 
 

Returns:

a new PersonSearcher

validator

PersonService.Validator validator()

Get the validator of the Person Service.