Class User

Index

Constructors

Properties

Methods

addContentWatcher addSpaceWatch getAnonymousUser getContentWatchStatus getCurrentUser getGroupMembershipsForUser getUser isWatchingSpace removeContentWatcher removeSpaceWatch

Constructors

constructor

new User(client): Server.User
Parameters
- client: Client
Returns Server.User
- Defined in server/user.ts:9

Properties

`Private` client

client: Client

Methods

addContentWatcher

addContentWatcher<T>(parameters, callback): Promise<void>
Create a new watcher for the given user and content id.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.AddContentWatcher
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:138
addContentWatcher<T>(parameters, callback?): Promise<T>
Create a new watcher for the given user and content id.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.AddContentWatcher
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:146

addSpaceWatch

addSpaceWatch<T>(parameters, callback): Promise<void>
Create a new watcher for the given user and space key.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: AddSpaceWatch
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:240
addSpaceWatch<T>(parameters, callback?): Promise<T>
Create a new watcher for the given user and space key.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: AddSpaceWatch
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:248

getAnonymousUser

getAnonymousUser<T>(callback): Promise<void>
Get information about the how anonymous is represented in confluence
Type Parameters
- T = ServerModels.UserAnonymous
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:30
getAnonymousUser<T>(callback?): Promise<T>
Get information about the how anonymous is represented in confluence
Type Parameters
- T = ServerModels.UserAnonymous
Parameters
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:32

getContentWatchStatus

getContentWatchStatus<T>(parameters, callback): Promise<void>
Get information about whether a user is watching a specified content.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = ServerModels.UserWatch
Parameters
- parameters: ServerParameters.GetContentWatchStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:100
getContentWatchStatus<T>(parameters, callback?): Promise<T>
Get information about whether a user is watching a specified content.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = ServerModels.UserWatch
Parameters
- parameters: ServerParameters.GetContentWatchStatus
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:111

getCurrentUser

getCurrentUser<T>(parameters, callback): Promise<void>
Get information about the current logged-in user.
Type Parameters
- T = ServerModels.User
Parameters
- parameters: undefined | ServerParameters.GetCurrentUser
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:43
getCurrentUser<T>(parameters?, callback?): Promise<T>
Get information about the current logged-in user.
Type Parameters
- T = ServerModels.User
Parameters
- Optional parameters: ServerParameters.GetCurrentUser
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:48

getGroupMembershipsForUser

getGroupMembershipsForUser<T>(parameters, callback): Promise<void>
Get a paginated collection of groups that the given user is a member of
Type Parameters
- T = Pagination<ServerModels.Group>
Parameters
- parameters: undefined | ServerParameters.GetGroups
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:65
getGroupMembershipsForUser<T>(parameters?, callback?): Promise<T>
Get a paginated collection of groups that the given user is a member of
Type Parameters
- T = Pagination<ServerModels.Group>
Parameters
- Optional parameters: ServerParameters.GetGroups
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:70

getUser

getUser<T>(parameters, callback): Promise<void>
Get information about a user identified by either user key or username.
Type Parameters
- T = ServerModels.User
Parameters
- parameters: undefined | ServerParameters.GetUser
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:12
getUser<T>(parameters?, callback?): Promise<T>
Get information about a user identified by either user key or username.
Type Parameters
- T = ServerModels.User
Parameters
- Optional parameters: ServerParameters.GetUser
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:14

isWatchingSpace

isWatchingSpace<T>(parameters, callback): Promise<void>
Get information about whether a user is watching a specified space.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = ServerModels.UserWatch
Parameters
- parameters: ServerParameters.IsWatchingSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:205
isWatchingSpace<T>(parameters, callback?): Promise<T>
Get information about whether a user is watching a specified space.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = ServerModels.UserWatch
Parameters
- parameters: ServerParameters.IsWatchingSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:216

removeContentWatcher

removeContentWatcher<T>(parameters, callback): Promise<void>
Delete an existing watcher for the given user and content id.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.RemoveContentWatcher
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:170
removeContentWatcher<T>(parameters, callback?): Promise<T>
Delete an existing watcher for the given user and content id.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.RemoveContentWatcher
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:181

removeSpaceWatch

removeSpaceWatch<T>(parameters, callback): Promise<void>
Delete an existing watcher for the given user and space key.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.RemoveSpaceWatch
- callback: Callback<T>
Returns Promise<void>
- Defined in server/user.ts:269
removeSpaceWatch<T>(parameters, callback?): Promise<T>
Delete an existing watcher for the given user and space key.

User is optional. If not specified, currently logged-in user will be used. Otherwise, it can be specified by either user key or username. When a user is specified and is different from the logged-in user, the logged-in user needs to be a Confluence administrator.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.RemoveSpaceWatch
- Optional callback: undefined
Returns Promise<T>
- Defined in server/user.ts:277

Class User

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Server.User

Properties

Private client

Methods

addContentWatcher

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

addSpaceWatch

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAnonymousUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentWatchStatus

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getCurrentUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupMembershipsForUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

isWatchingSpace

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeContentWatcher

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeSpaceWatch

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

`Private` client