Group

Extends

• Entity

Constructors

new Group()

new Group(dart): Group

Parameters

Parameter	Type
dart	any

Returns

Group

Overrides

Entity . constructor

Constructs

Group

Source

src/entities.ts:755

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart

Accessors

adminMembers

get adminMembers(): Group[]

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

Returns

Group[]

Source

src/entities.ts:791

---

adminMemberships

get adminMemberships(): Group[]

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

Returns

Group[]

Source

src/entities.ts:799

---

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:108

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:99

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:85

---

hidden

get hidden(): boolean

Hidden group

set hidden(e): void

Parameters

Parameter	Type
e	boolean

Returns

boolean

Source

src/entities.ts:806

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:77

---

members

get members(): Group[]

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

Returns

Group[]

Source

src/entities.ts:787

---

memberships

get memberships(): Group[]

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

Returns

Group[]

Source

src/entities.ts:795

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:89

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:93

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:96

---

personal

get personal(): boolean

Personal user group

set personal(e): void

Parameters

Parameter	Type
e	boolean

Returns

boolean

Source

src/entities.ts:802

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:102

---

defaultGroupsIds

get static defaultGroupsIds(): object

Returns

object

Member	Type	Value
Admin	"a4b45840-9a50-11e6-c537-6bf8e9ab02ee"	"a4b45840-9a50-11e6-c537-6bf8e9ab02ee"
Administrators	"1ab8b38d-9c4e-4b1e-81c3-ae2bde3e12c5"	"1ab8b38d-9c4e-4b1e-81c3-ae2bde3e12c5"
All users	"a4b45840-9a50-11e6-9cc9-8546b8bf62e6"	"a4b45840-9a50-11e6-9cc9-8546b8bf62e6"
Developers	"ba9cd191-9a50-11e6-9cc9-910bf827f0ab"	"ba9cd191-9a50-11e6-9cc9-910bf827f0ab"
Need to create	"00000000-0000-0000-0000-000000000000"	"00000000-0000-0000-0000-000000000000"
System	"a4b45840-ac9c-4d39-8b4b-4db3e576b3c3"	"a4b45840-ac9c-4d39-8b4b-4db3e576b3c3"
Test	"ca1e672e-e3be-40e0-b79b-8546b8bf62e6"	"ca1e672e-e3be-40e0-b79b-8546b8bf62e6"

Source

src/entities.ts:809

Methods

addAdminMember()

addAdminMember(m): void

Adds an admin member to the group

Parameters

Parameter	Type	Description
m	Group

Returns

void

Source

src/entities.ts:767

---

addMember()

addMember(m): void

Adds a member to the group

Parameters

Parameter	Type	Description
m	Group

Returns

void

Source

src/entities.ts:763

---

excludeFrom()

excludeFrom(m): void

Removes membership from another group

Parameters

Parameter	Type	Description
m	Group

Returns

void

Source

src/entities.ts:783

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:111

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:123

---

includeAdminTo()

includeAdminTo(m): void

Adds the group to another one as an admin

Parameters

Parameter	Type	Description
m	Group

Returns

void

Source

src/entities.ts:779

---

includeTo()

includeTo(m): void

Adds the group to another one

Parameters

Parameter	Type	Description
m	Group

Returns

void

Source

src/entities.ts:775

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:81

---

removeMember()

removeMember(m): void

Removes a member from the group

Parameters

Parameter	Type	Description
m	Group

Returns

void

Source

src/entities.ts:771

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:116

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:126

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:121

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:129

---

create()

static create(name): Group

Parameters

Parameter	Type
name	string

Returns

Group

Source

src/entities.ts:759