Class: IQGroup

group.IQGroup

Group class for managing user groups

Table of contents

Constructors

• constructor

Accessors

• accessLevel
• description
• id
• members
• name
• permissions

Methods

• addMember
• delete
• exists
• getRawData
• hasMember
• hasPermission
• memberCount
• removeMember
• setPermission
• update

Constructors

constructor

• new IQGroup(options)

Parameters

Name	Type
options	string | IGroupOptions

Defined in

core/src/group.ts:373

Accessors

accessLevel

• get accessLevel(): UserAccessLevel

Get group access level

Returns

UserAccessLevel

Defined in

core/src/group.ts:416

---

description

• get description(): string

Get group description

Returns

string

Defined in

core/src/group.ts:409

---

id

• get id(): number

Get group ID

Returns

number

Defined in

core/src/group.ts:402

---

members

• get members(): string[]

Get group members

Returns

string[]

Defined in

core/src/group.ts:430

---

name

• get name(): string

Get group name

Returns

string

Defined in

core/src/group.ts:395

---

permissions

• get permissions(): null | IGroupPermissions

Get group permissions

Returns

null | IGroupPermissions

Defined in

core/src/group.ts:423

Methods

addMember

▸ addMember(handle): boolean

Add member to group

Parameters

Name	Type
handle	string

Returns

boolean

Defined in

core/src/group.ts:444

---

delete

▸ delete(): boolean

Delete group

Returns

boolean

Defined in

core/src/group.ts:515

---

exists

▸ exists(): boolean

Check if group exists

Returns

boolean

Defined in

core/src/group.ts:437

---

getRawData

▸ getRawData(): null | IGroupData

Get raw group data

Returns

null | IGroupData

Defined in

core/src/group.ts:527

---

hasMember

▸ hasMember(handle): boolean

Check if user is member

Parameters

Name	Type
handle	string

Returns

boolean

Defined in

core/src/group.ts:470

---

hasPermission

▸ hasPermission(permission): boolean

Check permission

Parameters

Name	Type
permission	keyof IGroupPermissions

Returns

boolean

Defined in

core/src/group.ts:484

---

memberCount

▸ memberCount(): number

Get member count

Returns

number

Defined in

core/src/group.ts:477

---

removeMember

▸ removeMember(handle): boolean

Remove member from group

Parameters

Name	Type
handle	string

Returns

boolean

Defined in

core/src/group.ts:456

---

setPermission

▸ setPermission(permission, value): boolean

Set permission

Parameters

Name	Type
permission	keyof IGroupPermissions
value	number | boolean

Returns

boolean

Defined in

core/src/group.ts:493

---

update

▸ update(updates): boolean

Update group data

Parameters

Name	Type
updates	Partial<IGroupData>

Returns

boolean

Defined in

core/src/group.ts:503