Skip to main content

Group

Extends

Constructors

new Group()

new Group(dart): Group

Parameters

ParameterType
dartany

Returns

Group

Overrides

Entity . constructor

Constructs

Group

Source

src/entities.ts:926

Properties

PropertyModifierTypeInherited from
dartpublicanyEntity.dart

Accessors

adminMembers

get adminMembers(): Group[]

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

Returns

Group[]

Source

src/entities.ts:962


adminMemberships

get adminMemberships(): Group[]

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

Returns

Group[]

Source

src/entities.ts:970


author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:119


createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:110


friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:96


hidden

get hidden(): boolean

Hidden group

set hidden(e): void

Parameters

ParameterType
eboolean

Returns

boolean

Source

src/entities.ts:977


id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:88


members

get members(): Group[]

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

Returns

Group[]

Source

src/entities.ts:958


memberships

get memberships(): Group[]

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

Returns

Group[]

Source

src/entities.ts:966


name

get name(): string

Entity short name

set name(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:100


nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:104


path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:107


personal

get personal(): boolean

Personal user group

set personal(e): void

Parameters

ParameterType
eboolean

Returns

boolean

Source

src/entities.ts:973


updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:113


defaultGroupsIds

get static defaultGroupsIds(): object

Returns

object

MemberTypeValue
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:980

Methods

addAdminMember()

addAdminMember(m): void

Adds an admin member to the group

Parameters

ParameterTypeDescription
mGroup

Returns

void

Source

src/entities.ts:938


addMember()

addMember(m): void

Adds a member to the group

Parameters

ParameterTypeDescription
mGroup

Returns

void

Source

src/entities.ts:934


excludeFrom()

excludeFrom(m): void

Removes membership from another group

Parameters

ParameterTypeDescription
mGroup

Returns

void

Source

src/entities.ts:954


getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:122


hasTag()

hasTag(tag): boolean

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:134


includeAdminTo()

includeAdminTo(m): void

Adds the group to another one as an admin

Parameters

ParameterTypeDescription
mGroup

Returns

void

Source

src/entities.ts:950


includeTo()

includeTo(m): void

Adds the group to another one

Parameters

ParameterTypeDescription
mGroup

Returns

void

Source

src/entities.ts:946


newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:92


removeMember()

removeMember(m): void

Removes a member from the group

Parameters

ParameterTypeDescription
mGroup

Returns

void

Source

src/entities.ts:942


setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

ParameterType
propsobject

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:127


tag()

tag(tag): boolean

Adds a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:137


toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:132


unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:140


create()

static create(name): Group

Parameters

ParameterType
namestring

Returns

Group

Source

src/entities.ts:930