Skip to main content

Class: Group

dg.Group

Hierarchy

Constructors

constructor

new Group(dart)

Constructs

Group

Parameters

NameType
dartany

Overrides

Entity.constructor

Defined in

src/entities.ts:719

Properties

dart

dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

Accessors

adminMembers

get adminMembers(): Group[]

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

Returns

Group[]

Defined in

src/entities.ts:755


adminMemberships

get adminMemberships(): Group[]

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

Returns

Group[]

Defined in

src/entities.ts:763


author

get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104


createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98


friendlyName

get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

set friendlyName(x): void

Parameters

NameType
xstring

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85


hidden

get hidden(): boolean

Hidden group

Returns

boolean

Defined in

src/entities.ts:770

set hidden(e): void

Parameters

NameType
eboolean

Returns

void

Defined in

src/entities.ts:771


id

get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

set id(x): void

Parameters

NameType
xstring

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77


members

get members(): Group[]

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

Returns

Group[]

Defined in

src/entities.ts:751


memberships

get memberships(): Group[]

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

Returns

Group[]

Defined in

src/entities.ts:759


name

get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

set name(x): void

Parameters

NameType
xstring

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89


nqName

get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92


path

get path(): string

Entity path

Returns

string

Inherited from

Entity.path

Defined in

src/entities.ts:95


personal

get personal(): boolean

Personal user group

Returns

boolean

Defined in

src/entities.ts:766

set personal(e): void

Parameters

NameType
eboolean

Returns

void

Defined in

src/entities.ts:767


updatedOn

get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101


defaultGroupsIds

Static get defaultGroupsIds(): Object

Returns

Object

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

Defined in

src/entities.ts:773

Methods

addAdminMember

addAdminMember(m): void

Adds an admin member to the group

Parameters

NameType
mGroup

Returns

void

Defined in

src/entities.ts:731


addMember

addMember(m): void

Adds a member to the group

Parameters

NameType
mGroup

Returns

void

Defined in

src/entities.ts:727


excludeFrom

excludeFrom(m): void

Removes membership from another group

Parameters

NameType
mGroup

Returns

void

Defined in

src/entities.ts:747


getProperties

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

Gets entity properties

Returns

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

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107


hasTag

hasTag(tag): boolean

Parameters

NameType
tagstring

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119


includeAdminTo

includeAdminTo(m): void

Adds the group to another one as an admin

Parameters

NameType
mGroup

Returns

void

Defined in

src/entities.ts:743


includeTo

includeTo(m): void

Adds the group to another one

Parameters

NameType
mGroup

Returns

void

Defined in

src/entities.ts:739


newId

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80


removeMember

removeMember(m): void

Removes a member from the group

Parameters

NameType
mGroup

Returns

void

Defined in

src/entities.ts:735


setProperties

setProperties(props): Promise<any>

Sets entity properties

Parameters

NameType
propsObject

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112


tag

tag(tag): boolean

Adds a specified tag

Parameters

NameType
tagstring

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122


toString

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117


unTag

unTag(tag): boolean

Removes a specified tag

Parameters

NameType
tagstring

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125


create

Static create(name): Group

Parameters

NameType
namestring

Returns

Group

Defined in

src/entities.ts:723