Group

Defined in: js-api/src/entities/user.ts:114

Represents a User Group

Extends

• Entity

Constructors

Constructor

new Group(dart): Group

Defined in: js-api/src/entities/user.ts:116

Parameters

Parameter	Type
dart	any

Returns

Group

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
dart	public	any	Entity.dart	js-api/src/entities/entity.ts:19

Accessors

adminMembers

Get Signature

get adminMembers(): Group[]

Defined in: js-api/src/entities/user.ts:144

Returns list of groups that belong to group, with admin permissions

Returns

Group[]

---

adminMemberships

Get Signature

get adminMemberships(): Group[]

Defined in: js-api/src/entities/user.ts:150

Returns list of groups that group belongs to, with admin permissions

Returns

Group[]

---

author

Get Signature

get author(): any

Defined in: js-api/src/entities/entity.ts:57

Who created entity *

Returns

any

Inherited from

Entity.author

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:48

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:64

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:34

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:35

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

hidden

Get Signature

get hidden(): boolean

Defined in: js-api/src/entities/user.ts:157

Hidden group

Returns

boolean

Set Signature

set hidden(e): void

Defined in: js-api/src/entities/user.ts:158

Parameters

Parameter	Type
e	boolean

Returns

void

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:27

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:28

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

members

Get Signature

get members(): Group[]

Defined in: js-api/src/entities/user.ts:141

Returns list of groups that belong to group, with no admin permissions

Returns

Group[]

---

memberships

Get Signature

get memberships(): Group[]

Defined in: js-api/src/entities/user.ts:147

Returns list of groups that group belongs to, with no admin permissions

Returns

Group[]

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/entity.ts:38

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/entity.ts:39

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:42

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/entity.ts:45

Entity path

Returns

string

Inherited from

Entity.path

---

personal

Get Signature

get personal(): boolean

Defined in: js-api/src/entities/user.ts:153

Personal user group

Returns

boolean

Set Signature

set personal(e): void

Defined in: js-api/src/entities/user.ts:154

Parameters

Parameter	Type
e	boolean

Returns

void

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:51

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

---

user

Get Signature

get user(): User

Defined in: js-api/src/entities/user.ts:164

Returns associated user. Returns null if the group is not personal. See Groups

Returns

User

---

admin

Get Signature

get static admin(): Group

Defined in: js-api/src/entities/user.ts:186

Returns

Group

---

administrators

Get Signature

get static administrators(): Group

Defined in: js-api/src/entities/user.ts:190

Returns

Group

---

allUsers

Get Signature

get static allUsers(): Group

Defined in: js-api/src/entities/user.ts:178

Returns

Group

---

defaultGroupsIds

Get Signature

get static defaultGroupsIds(): object

Defined in: js-api/src/entities/user.ts:166

Returns

object

Name	Type	Default value	Defined in
Admin	"a4b45840-9a50-11e6-c537-6bf8e9ab02ee"	"a4b45840-9a50-11e6-c537-6bf8e9ab02ee"	js-api/src/entities/user.ts:172
Administrators	"1ab8b38d-9c4e-4b1e-81c3-ae2bde3e12c5"	"1ab8b38d-9c4e-4b1e-81c3-ae2bde3e12c5"	js-api/src/entities/user.ts:174
All users	"a4b45840-9a50-11e6-9cc9-8546b8bf62e6"	"a4b45840-9a50-11e6-9cc9-8546b8bf62e6"	js-api/src/entities/user.ts:168
Developers	"ba9cd191-9a50-11e6-9cc9-910bf827f0ab"	"ba9cd191-9a50-11e6-9cc9-910bf827f0ab"	js-api/src/entities/user.ts:169
Need to create	"00000000-0000-0000-0000-000000000000"	"00000000-0000-0000-0000-000000000000"	js-api/src/entities/user.ts:170
System	"a4b45840-ac9c-4d39-8b4b-4db3e576b3c3"	"a4b45840-ac9c-4d39-8b4b-4db3e576b3c3"	js-api/src/entities/user.ts:173
Test	"ca1e672e-e3be-40e0-b79b-8546b8bf62e6"	"ca1e672e-e3be-40e0-b79b-8546b8bf62e6"	js-api/src/entities/user.ts:171

---

developers

Get Signature

get static developers(): Group

Defined in: js-api/src/entities/user.ts:180

Returns

Group

---

needToCreate

Get Signature

get static needToCreate(): Group

Defined in: js-api/src/entities/user.ts:182

Returns

Group

---

system

Get Signature

get static system(): Group

Defined in: js-api/src/entities/user.ts:188

Returns

Group

---

test

Get Signature

get static test(): Group

Defined in: js-api/src/entities/user.ts:184

Returns

Group

Methods

addAdminMember()

addAdminMember(m): void

Defined in: js-api/src/entities/user.ts:126

Adds an admin member to the group

Parameters

Parameter	Type
m	Group

Returns

void

---

addMember()

addMember(m): void

Defined in: js-api/src/entities/user.ts:123

Adds a member to the group

Parameters

Parameter	Type
m	Group

Returns

void

---

excludeFrom()

excludeFrom(m): void

Defined in: js-api/src/entities/user.ts:138

Removes membership from another group

Parameters

Parameter	Type
m	Group

Returns

void

---

getProperties()

getProperties(): Promise<{[index: string]: any; }>

Defined in: js-api/src/entities/entity.ts:67

Gets entity properties

Returns

Promise<{[index: string]: any; }>

Inherited from

Entity.getProperties

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:79

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

includeAdminTo()

includeAdminTo(m): void

Defined in: js-api/src/entities/user.ts:135

Adds the group to another one as an admin

Parameters

Parameter	Type
m	Group

Returns

void

---

includeTo()

includeTo(m): void

Defined in: js-api/src/entities/user.ts:132

Adds the group to another one

Parameters

Parameter	Type
m	Group

Returns

void

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:31

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

removeMember()

removeMember(m): void

Defined in: js-api/src/entities/user.ts:129

Removes a member from the group

Parameters

Parameter	Type
m	Group

Returns

void

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:72

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:82

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:77

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:85

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

---

create()

static create(name): Group

Defined in: js-api/src/entities/user.ts:120

Parameters

Parameter	Type
name	string

Returns

Group