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