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 and Description
static interface	PersonService.PersonFinder A finder for locating persons.
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 and Description
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.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

validator

PersonService.Validator validator()

Get the validator of the Person Service.