Class: Group
dg.Group
Hierarchy
↳
Group
Constructors
constructor
• new Group(dart
)
Constructs
Group
Parameters
Name | Type |
---|---|
dart | any |
Overrides
Defined in
Properties
dart
• dart: any
Inherited from
Defined in
Accessors
adminMembers
• get
adminMembers(): Group
[]
Returns list of groups that belong to group, with admin permissions
Returns
Group
[]
Defined in
adminMemberships
• get
adminMemberships(): Group
[]
Returns list of groups that group belongs to, with admin permissions
Returns
Group
[]
Defined in
author
• get
author(): User
Who created entity *
Returns
Inherited from
Entity.author
Defined in
createdOn
• get
createdOn(): Dayjs
Time when entity was created *
Returns
Dayjs
Inherited from
Entity.createdOn
Defined in
friendlyName
• get
friendlyName(): string
Entity friendly name
Returns
string
Inherited from
Entity.friendlyName
Defined in
• set
friendlyName(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.friendlyName
Defined in
hidden
• get
hidden(): boolean
Hidden group
Returns
boolean
Defined in
• set
hidden(e
): void
Parameters
Name | Type |
---|---|
e | boolean |
Returns
void
Defined in
id
• get
id(): string
Entity ID (GUID)
Returns
string
Inherited from
Entity.id
Defined in
• set
id(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.id
Defined in
members
• get
members(): Group
[]
Returns list of groups that belong to group, with no admin permissions
Returns
Group
[]
Defined in
memberships
• get
memberships(): Group
[]
Returns list of groups that group belongs to, with no admin permissions
Returns
Group
[]
Defined in
name
• get
name(): string
Entity short name
Returns
string
Inherited from
Entity.name
Defined in
• set
name(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.name
Defined in
nqName
• get
nqName(): string
Entity full-qualified name
Returns
string
Inherited from
Entity.nqName
Defined in
path
• get
path(): string
Entity path
Returns
string
Inherited from
Entity.path
Defined in
personal
• get
personal(): boolean
Personal user group
Returns
boolean
Defined in
• set
personal(e
): void
Parameters
Name | Type |
---|---|
e | boolean |
Returns
void
Defined in
updatedOn
• get
updatedOn(): Dayjs
Time when entity was updated *
Returns
Dayjs
Inherited from
Entity.updatedOn
Defined in
defaultGroupsIds
• Static
get
defaultGroupsIds(): Object
Returns
Object
Name | Type |
---|---|
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
Methods
addAdminMember
▸ addAdminMember(m
): void
Adds an admin member to the group
Parameters
Name | Type |
---|---|
m | Group |
Returns
void
Defined in
addMember
▸ addMember(m
): void
Adds a member to the group
Parameters
Name | Type |
---|---|
m | Group |
Returns
void
Defined in
excludeFrom
▸ excludeFrom(m
): void
Removes membership from another group
Parameters
Name | Type |
---|---|
m | Group |
Returns
void
Defined in
getProperties
▸ getProperties(): Promise
<{ [index: string]
: any
; }>
Gets entity properties
Returns
Promise
<{ [index: string]
: any
; }>
Inherited from
Defined in
hasTag
▸ hasTag(tag
): boolean
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
includeAdminTo
▸ includeAdminTo(m
): void
Adds the group to another one as an admin
Parameters
Name | Type |
---|---|
m | Group |
Returns
void
Defined in
includeTo
▸ includeTo(m
): void
Adds the group to another one
Parameters
Name | Type |
---|---|
m | Group |
Returns
void
Defined in
newId
▸ newId(): void
Generates new id for this entity.
Returns
void
Inherited from
Defined in
removeMember
▸ removeMember(m
): void
Removes a member from the group
Parameters
Name | Type |
---|---|
m | Group |
Returns
void
Defined in
setProperties
▸ setProperties(props
): Promise
<any
>
Sets entity properties
Parameters
Name | Type |
---|---|
props | Object |
Returns
Promise
<any
>
Inherited from
Defined in
tag
▸ tag(tag
): boolean
Adds a specified tag
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
toString
▸ toString(): string
Returns a string representing the object
Returns
string
Inherited from
Defined in
unTag
▸ unTag(tag
): boolean
Removes a specified tag
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
create
▸ Static
create(name
): Group
Parameters
Name | Type |
---|---|
name | string |