Class Group

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Private` client

client: Client

Methods

addUserToGroup

addUserToGroup<T>(parameters, callback): 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 api/group.ts:457
addUserToGroup<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:463

addUserToGroupByGroupId

addUserToGroupByGroupId<T>(parameters, callback): 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 api/group.ts:346
addUserToGroupByGroupId<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:355

createGroup

createGroup<T>(parameters, callback): 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 api/group.ts:49
createGroup<T>(parameters?, callback?): Promise<T>
Creates a new user group.

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

getGroup

getGroup<T>(parameters, callback): Promise<void>
Type Parameters
- T = Models.Group
Parameters
- parameters: Parameters.GetGroup
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in the next major version. Use getGroupByName instead.
- Defined in api/group.ts:187
getGroup<T>(parameters, callback?): Promise<T>
Type Parameters
- T = Models.Group
Parameters
- parameters: Parameters.GetGroup
- Optional callback: undefined
Returns Promise<T>
Deprecated
Will be removed in the next major version. Use getGroupByName instead.
- Defined in api/group.ts:189

getGroupByGroupId

getGroupByGroupId<T>(parameters, callback): 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 api/group.ts:136
getGroupByGroupId<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:146

getGroupByName

getGroupByName<T>(parameters, callback): 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>
- Defined in api/group.ts:202
getGroupByName<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:211

getGroupByQueryParam

getGroupByQueryParam<T>(parameters, callback): 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>
- Defined in api/group.ts:101
getGroupByQueryParam<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:111

getGroupMembers

getGroupMembers<T>(parameters, callback): 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 = Models.UserArray
Parameters
- parameters: GetGroupMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/group.ts:270
getGroupMembers<T>(parameters, callback?): 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 = Models.UserArray
Parameters
- parameters: GetGroupMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:282

getGroupMembersByGroupId

getGroupMembersByGroupId<T>(parameters, callback): 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 = Models.UserArray
Parameters
- parameters: GetGroupMembersByGroupId
- callback: Callback<T>
Returns Promise<void>
- Defined in api/group.ts:419
getGroupMembersByGroupId<T>(parameters, callback?): 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 = Models.UserArray
Parameters
- parameters: GetGroupMembersByGroupId
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:431

getGroups

getGroups<T>(parameters, callback): 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 | Parameters.GetGroups
- callback: Callback<T>
Returns Promise<void>
- Defined in api/group.ts:16
getGroups<T>(parameters?, callback?): 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
- Optional parameters: Parameters.GetGroups
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:26

getGroupsSearch

getGroupsSearch<T>(parameters, callback): Promise<void>
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: GetGroupsSearch
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in the next major version. Use searchGroups instead.
- Defined in api/group.ts:300
getGroupsSearch<T>(parameters, callback?): Promise<T>
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: GetGroupsSearch
- Optional callback: undefined
Returns Promise<T>
Deprecated
Will be removed in the next major version. Use searchGroups instead.
- Defined in api/group.ts:305

getMembersByQueryParam

getMembersByQueryParam<T>(parameters, callback): 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 = Models.UserArray
Parameters
- parameters: GetMembersByQueryParam
- callback: Callback<T>
Returns Promise<void>
- Defined in api/group.ts:230
getMembersByQueryParam<T>(parameters, callback?): 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 = Models.UserArray
Parameters
- parameters: GetMembersByQueryParam
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:240

removeGroup

removeGroup<T>(parameters, callback): 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>
- Defined in api/group.ts:76
removeGroup<T>(parameters, callback?): Promise<T>
Delete user group.

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveGroup
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:82

removeGroupById

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

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

Permissions required: User must be a site admin.
Type Parameters
- T = void
Parameters
- parameters: RemoveGroupById
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:173

removeMemberFromGroup

removeMemberFromGroup<T>(parameters, callback): 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 api/group.ts:484
removeMemberFromGroup<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:493

removeMemberFromGroupByGroupId

removeMemberFromGroupByGroupId<T>(parameters, callback): 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 api/group.ts:382
removeMemberFromGroupByGroupId<T>(parameters, callback?): 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
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:391

searchGroups

searchGroups<T>(parameters, callback): 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 api/group.ts:317
searchGroups<T>(parameters, callback?): Promise<T>
Get search results of groups by partial query provided.
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: SearchGroups
- Optional callback: undefined
Returns Promise<T>
- Defined in api/group.ts:322

Class Group

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Api.Group

Properties

Private client

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>

getGroup

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

getGroupByGroupId

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupByName

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupByQueryParam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupMembers

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupMembersByGroupId

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroups

Type Parameters

Parameters

`Private` client