Users (confluence-infra 8.14.0-SNAPSHOT API)

com.adaptavist.hapi.confluence.users.Users

@com.adaptavist.hapi.platform.analytics.Tracked
class Users
extends java.lang.Object

Constructor Summary

Constructors
Constructor and description
`Users()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static com.atlassian.user.User`	`getByKey(com.atlassian.sal.api.user.UserKey userKey)` Retrieves a User by userKey
	`static com.atlassian.user.User`	`getByKey(java.lang.String userKey)` Retrieves a User by string corresponding to the user's userKey Users.getByKey('ff8080818b0052d3018b006f216d0000')
	`static com.atlassian.user.User`	`getByName(java.lang.String username)` Retrieves a User by name Users.getByName('username')
	`static UserIterator`	`getInactiveUsers(java.time.Duration durationSinceLastLogin)` Get users who have been inactive for a specified amount of time, example usage: Users.getInactiveUsers(Duration.of(90, ChronoUnit.DAYS))
	`static com.atlassian.confluence.user.ConfluenceUser`	`getLoggedInUser()` Get the current logged in user, may be null if the logged in user is anonymous, example usage: Users.getLoggedInUser()
`<T>`	`static T`	`runAnonymously(java.util.concurrent.Callable<T> callable)` Run an action with no logged in user, returning the result, example usage: def pages = Users.runAnonymously { Pages.search('space = ds') }
`<T>`	`static T`	`runAs(java.lang.String username, java.util.concurrent.Callable<T> callable)` Run an action as a different user, returning the result, example usage: def pages = Users.runAs('username') { Pages.search('space = ds') }
`<T>`	`static T`	`runAs(com.atlassian.confluence.user.ConfluenceUser user, java.util.concurrent.Callable<T> callable)` Run an action as a different user, returning the result, example usage: def pages = Users.runAs(Users.getByName('username')) { Pages.search('space = ds') }

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - Users()
- Method Detail
  - static com.atlassian.user.User getByKey(com.atlassian.sal.api.user.UserKey userKey)
    
    Retrieves a User by userKey
    throws:
    InvalidUserKeyException if no user can be found with matching key
    
    Parameters:
    userKey - the userKey of the user to retrieve
    Returns:
    the user with the matching key
  - static com.atlassian.user.User getByKey(java.lang.String userKey)
    
    Retrieves a User by string corresponding to the user's userKey
```
 Users.getByKey('ff8080818b0052d3018b006f216d0000')
 
```
    throws:
    InvalidUserKeyException if no user can be found with matching key
    
    Parameters:
    userKey - the string corresponding to the userKey of the user to retrieve
    Returns:
    the user with the matching key
  - static com.atlassian.user.User getByName(java.lang.String username)
    
    Retrieves a User by name
```
 Users.getByName('username')
 
```
    throws:
    InvalidUsernameException if no user can be found with matching name
    
    Parameters:
    username - the name of the user to retrieve
    Returns:
    the user with matching name
  - static UserIterator getInactiveUsers(java.time.Duration durationSinceLastLogin)
    
    Get users who have been inactive for a specified amount of time, example usage:
```
 Users.getInactiveUsers(Duration.of(90, ChronoUnit.DAYS))
 
```
    throws:
    GetUsersException if retrieving inactive users fails
    throws:
    java.lang.IllegalArgumentException if a negative integer is passed in
    
    Parameters:
    durationSinceLastLogin - Duration representing the maximum duration of time since a user's last login in order to be considered active
    Returns:
    an iterator of users who have been inactive for the number of months specified
  - static com.atlassian.confluence.user.ConfluenceUser getLoggedInUser()
    
    Get the current logged in user, may be null if the logged in user is anonymous, example usage:
```
 Users.getLoggedInUser()
 
```
    Returns:
    the logged in user or null if no logged in user present
  - <T> static T runAnonymously(java.util.concurrent.Callable<T> callable)
    
    Run an action with no logged in user, returning the result, example usage:
```
 def pages = Users.runAnonymously {
     Pages.search('space = ds')
 }
```
    Parameters:
    callable - the action to run, which returns a result
    Returns:
    the result of the provided action
  - <T> static T runAs(java.lang.String username, java.util.concurrent.Callable<T> callable)
    
    Run an action as a different user, returning the result, example usage:
```
 def pages = Users.runAs('username') {
     Pages.search('space = ds')
 }
```
    throws:
    InvalidUsernameException if no user can be found with matching name
    
    Parameters:
    username - user to run the action as
    callable - the action to run, which returns a result
    Returns:
    the result of the provided action
  - <T> static T runAs(com.atlassian.confluence.user.ConfluenceUser user, java.util.concurrent.Callable<T> callable)
    
    Run an action as a different user, returning the result, example usage:
```
 def pages = Users.runAs(Users.getByName('username')) {
     Pages.search('space = ds')
 }
```
    Parameters:
    user - user to run the action as
    callable - the action to run, which returns a result
    Returns:
    the result of the provided action

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Users

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Users()

Method Detail

static com.atlassian.user.User getByKey(com.atlassian.sal.api.user.UserKey userKey)

static com.atlassian.user.User getByKey(java.lang.String userKey)

static com.atlassian.user.User getByName(java.lang.String username)

static UserIterator getInactiveUsers(java.time.Duration durationSinceLastLogin)

static com.atlassian.confluence.user.ConfluenceUser getLoggedInUser()

<T> static T runAnonymously(java.util.concurrent.Callable<T> callable)

<T> static T runAs(java.lang.String username, java.util.concurrent.Callable<T> callable)

<T> static T runAs(com.atlassian.confluence.user.ConfluenceUser user, java.util.concurrent.Callable<T> callable)