Class Group

Index

Constructors

Methods

addUserToGroup addUserToGroupByGroupId createGroup getGroupByGroupId getGroupByName getGroupByQueryParam getGroupMembers getGroupMembersByGroupId getGroups getMembersByQueryParam removeGroup removeGroupById removeMemberFromGroup removeMemberFromGroupByGroupId searchGroups

Constructors

constructor

new Group(client: Client): Api.Group
Parameters
- client: Client
Returns Api.Group
- Defined in src/api/group.ts:8

Methods

addUserToGroup

addUserToGroup<T = unknown>(
parameters: AddUserToGroup,
callback: Callback<T>,
): Promise<void>
Adds a user as a member in a group.

Permissions required: User must be a site admin.
Type Parameters
- T = unknown
Parameters
- parameters: AddUserToGroup
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:412
addUserToGroup<T = unknown>(
parameters: AddUserToGroup,
callback?: undefined,
): Promise<T>
Adds a user as a member in a group.

Permissions required: User must be a site admin.
Type Parameters
- T = unknown
Parameters
- parameters: AddUserToGroup
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:418

addUserToGroupByGroupId

addUserToGroupByGroupId<T = unknown>(
parameters: AddUserToGroupByGroupId,
callback: Callback<T>,
): Promise<void>
Adds a user as a member in a group represented by its groupId

Permissions required: User must be a site admin.
Type Parameters
- T = unknown
Parameters
- parameters: AddUserToGroupByGroupId
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:342
addUserToGroupByGroupId<T = unknown>(
parameters: AddUserToGroupByGroupId,
callback?: undefined,
): Promise<T>
Adds a user as a member in a group represented by its groupId

Permissions required: User must be a site admin.
Type Parameters
- T = unknown
Parameters
- parameters: AddUserToGroupByGroupId
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:351

createGroup

createGroup<T = Models.Group>(
parameters: undefined | CreateGroup,
callback: Callback<T>,
): Promise<void>
Creates a new user group.

Permissions required: User must be a site admin.
Type Parameters
- T = Models.Group
Parameters
- parameters: undefined | CreateGroup
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:49
createGroup<T = Models.Group>(
parameters?: CreateGroup,
callback?: undefined,
): Promise<T>
Creates a new user group.

Permissions required: User must be a site admin.
Type Parameters
- T = Models.Group
Parameters
- Optionalparameters: CreateGroup
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:58

getGroupByGroupId

getGroupByGroupId<T = Models.Group>(
parameters: GetGroupByGroupId,
callback: Callback<T>,
): Promise<void>
Returns a user group for a given group id.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = Models.Group
Parameters
- parameters: GetGroupByGroupId
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:144
getGroupByGroupId<T = Models.Group>(
parameters: GetGroupByGroupId,
callback?: undefined,
): Promise<T>
Returns a user group for a given group id.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = Models.Group
Parameters
- parameters: GetGroupByGroupId
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:154

getGroupByName

getGroupByName<T = Models.Group>(
parameters: GetGroupByName,
callback: Callback<T>,
): Promise<void>
Returns a user group for a given group name.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = Models.Group
Parameters
- parameters: GetGroupByName
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:204
getGroupByName<T = Models.Group>(
parameters: GetGroupByName,
callback?: undefined,
): Promise<T>
Returns a user group for a given group name.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = Models.Group
Parameters
- parameters: GetGroupByName
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:215

getGroupByQueryParam

getGroupByQueryParam<T = Models.Group>(
parameters: GetGroupByQueryParam,
callback: Callback<T>,
): Promise<void>
Returns a user group for a given group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = Models.Group
Parameters
- parameters: GetGroupByQueryParam
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:107
getGroupByQueryParam<T = Models.Group>(
parameters: GetGroupByQueryParam,
callback?: undefined,
): Promise<T>
Returns a user group for a given group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = Models.Group
Parameters
- parameters: GetGroupByQueryParam
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:119

getGroupMembers

getGroupMembers<T = UserArray>(
parameters: GetGroupMembers,
callback: Callback<T>,
): Promise<void>
Returns the users that are members of a group.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserArray
Parameters
- parameters: GetGroupMembers
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version. Use group.getGroupMembersByGroupId
- Defined in src/api/group.ts:475
getGroupMembers<T = UserArray>(
parameters: GetGroupMembers,
callback?: undefined,
): Promise<T>
Returns the users that are members of a group.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserArray
Parameters
- parameters: GetGroupMembers
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version. Use group.getGroupMembersByGroupId
- Defined in src/api/group.ts:489

getGroupMembersByGroupId

getGroupMembersByGroupId<T = UserArray>(
parameters: GetGroupMembersByGroupId,
callback: Callback<T>,
): Promise<void>
Returns the users that are members of a group.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserArray
Parameters
- parameters: GetGroupMembersByGroupId
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:303
getGroupMembersByGroupId<T = UserArray>(
parameters: GetGroupMembersByGroupId,
callback?: undefined,
): Promise<T>
Returns the users that are members of a group.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserArray
Parameters
- parameters: GetGroupMembersByGroupId
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:315

getGroups

getGroups<T = GroupArrayWithLinks>(
parameters: undefined | GetGroups,
callback: Callback<T>,
): Promise<void>
Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: undefined | GetGroups
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:16
getGroups<T = GroupArrayWithLinks>(
parameters?: GetGroups,
callback?: undefined,
): Promise<T>
Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = GroupArrayWithLinks
Parameters
- Optionalparameters: GetGroups
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:26

getMembersByQueryParam

getMembersByQueryParam<T = UserArray>(
parameters: GetMembersByQueryParam,
callback: Callback<T>,
): Promise<void>
Returns the users that are members of a group.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserArray
Parameters
- parameters: GetMembersByQueryParam
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:236
getMembersByQueryParam<T = UserArray>(
parameters: GetMembersByQueryParam,
callback?: undefined,
): Promise<T>
Returns the users that are members of a group.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserArray
Parameters
- parameters: GetMembersByQueryParam
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:248

removeGroup

removeGroup<T = void>(
parameters: RemoveGroup,
callback: Callback<T>,
): Promise<void>
Delete user group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveGroup
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:78
removeGroup<T = void>(parameters: RemoveGroup, callback?: undefined): Promise<T>
Delete user group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveGroup
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/group.ts:86

removeGroupById

removeGroupById<T = void>(
parameters: DeleteGroupById,
callback: Callback<T>,
): Promise<void>
Delete user group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: DeleteGroupById
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:175
removeGroupById<T = void>(
parameters: DeleteGroupById,
callback?: undefined,
): Promise<T>
Delete user group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: DeleteGroupById
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:181

removeMemberFromGroup

removeMemberFromGroup<T = void>(
parameters: RemoveMemberFromGroup,
callback: Callback<T>,
): Promise<void>
Remove user as a member from a group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveMemberFromGroup
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:439
removeMemberFromGroup<T = void>(
parameters: RemoveMemberFromGroup,
callback?: undefined,
): Promise<T>
Remove user as a member from a group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveMemberFromGroup
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:448

removeMemberFromGroupByGroupId

removeMemberFromGroupByGroupId<T = void>(
parameters: RemoveMemberFromGroupByGroupId,
callback: Callback<T>,
): Promise<void>
Remove user as a member from a group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveMemberFromGroupByGroupId
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:378
removeMemberFromGroupByGroupId<T = void>(
parameters: RemoveMemberFromGroupByGroupId,
callback?: undefined,
): Promise<T>
Remove user as a member from a group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveMemberFromGroupByGroupId
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:387

searchGroups

searchGroups<T = GroupArrayWithLinks>(
parameters: SearchGroups,
callback: Callback<T>,
): Promise<void>
Get search results of groups by partial query provided.
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: SearchGroups
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/group.ts:271
searchGroups<T = GroupArrayWithLinks>(
parameters: SearchGroups,
callback?: undefined,
): Promise<T>
Get search results of groups by partial query provided.
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: SearchGroups
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/group.ts:276

Class Group

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Api.Group

Methods

addUserToGroup

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

addUserToGroupByGroupId

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createGroup

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupByGroupId

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupByName

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

getGroupByQueryParam

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

getGroupMembers

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

getGroupMembersByGroupId

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroups

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getMembersByQueryParam

Type Parameters