Class Group

A user group data model.

Written by Hunter Perrin for SciActive.

Author

Hunter Perrin [email protected]

Copyright

SciActive Inc

See

http://nymph.io/

Hierarchy

AbleObject<GroupData>
- Group

Index

Constructors

constructor

Constructors

constructor

new Group(guid?): Group
Parameters
- Optional guid: string
Returns Group
Overrides AbleObject.constructor
- Defined in packages/tilmeld/src/Group.ts:147

Properties

`Protected` `Optional` $allowlistData

$allowlistData?: string[] = ...

`Protected` `Optional` $allowlistTags

$allowlistTags?: string[] = []

`Protected` $clientEnabledMethods

$clientEnabledMethods: string[] = ...

`Protected` $data

$data: GroupData

`Protected` $dataHandler

$dataHandler: Object

`Protected` $dataStore

$dataStore: GroupData

`Protected` $isASleepingReference

$isASleepingReference: boolean

$nymph

$nymph: default

`Protected` $privateData

$privateData: string[] = ...

`Protected` $protectedData

$protectedData: string[]

`Protected` $protectedTags

$protectedTags: string[]

`Protected` $sdata

$sdata: SerializedEntityData

`Private` $skipAcWhenSaving

$skipAcWhenSaving: boolean = false

This is explicitly used only during the registration proccess.

`Protected` $sleepingReference

$sleepingReference: null | EntityReference

`Protected` $tags

$tags: never[] = []

cdate

cdate: null | number

guid

guid: null | string

mdate

mdate: null | number

`Private` `Static` DEFAULT_ALLOWLIST_DATA

DEFAULT_ALLOWLIST_DATA: string[] = []

`Private` `Static` DEFAULT_PRIVATE_DATA

DEFAULT_PRIVATE_DATA: string[] = ...

`Static` ETYPE

ETYPE: string = 'tilmeld_group'

The instance of Tilmeld to use for queries.

`Static` class

class: string = 'Group'

`Static` clientEnabledStaticMethods

clientEnabledStaticMethods: string[] = ...

`Static` nymph

nymph: default

`Static` pubSubEnabled

pubSubEnabled: boolean

`Static` restEnabled

restEnabled: boolean

`Static` searchRestrictedData

searchRestrictedData: string[] = ...

Methods

$addTag

$addTag(...tags): void
Parameters
- Rest ...tags: string[]
Returns void
Inherited from AbleObject.$addTag
- Defined in packages/nymph/dist/Entity.d.ts:35

$arraySearch

$arraySearch(array, strict?): number
Parameters
- array: any[]
- Optional strict: boolean
Returns number
Inherited from AbleObject.$arraySearch
- Defined in packages/nymph/dist/Entity.d.ts:36

$checkEmail

$checkEmail(): Promise<{
message: string;
result: boolean;
}>
Check that an email is unique.

Returns Promise<{
message: string;
result: boolean;
}>
An object with a boolean 'result' entry and a 'message' entry.
- Defined in packages/tilmeld/src/Group.ts:636

$checkGroupname

$checkGroupname(): Promise<{
message: string;
result: boolean;
}>
Check that a groupname is valid.

Returns Promise<{
message: string;
result: boolean;
}>
An object with a boolean 'result' entry and a 'message' entry.
- Defined in packages/tilmeld/src/Group.ts:547

$clearCache

$clearCache(): void
Returns void
Inherited from AbleObject.$clearCache
- Defined in packages/nymph/dist/Entity.d.ts:37

$delete

$delete(): Promise<boolean>
Returns Promise<boolean>
Overrides AbleObject.$delete
- Defined in packages/tilmeld/src/Group.ts:796

$equals

$equals(object): boolean
Parameters
- object: any
Returns boolean
Inherited from AbleObject.$equals
- Defined in packages/nymph/dist/Entity.d.ts:40

$getAvatar

$getAvatar(): string
Returns string
- Defined in packages/tilmeld/src/Group.ts:235

$getChildren

$getChildren(): Promise<(Group & GroupData)[]>
Gets an array of the group's child groups.

Returns Promise<(Group & GroupData)[]>
An array of groups.
- Defined in packages/tilmeld/src/Group.ts:403

$getClientEnabledMethods

$getClientEnabledMethods(): string[]
Returns string[]
Inherited from AbleObject.$getClientEnabledMethods
- Defined in packages/nymph/dist/Entity.d.ts:38

$getData

$getData(includeSData?): any
Parameters
- Optional includeSData: boolean
Returns any
Inherited from AbleObject.$getData
- Defined in packages/nymph/dist/Entity.d.ts:41

$getDescendants

$getDescendants(andSelf?): Promise<(Group & GroupData)[]>
Gets an array of the group's descendant groups.
Parameters
- andSelf: boolean = false
  
  Include this group in the returned array.
Returns Promise<(Group & GroupData)[]>
An array of groups.
- Defined in packages/tilmeld/src/Group.ts:421

$getDescendantsSync

$getDescendantsSync(andSelf?): (Group & GroupData)[]
Gets an array of the group's descendant groups.
Parameters
- andSelf: boolean = false
  
  Include this group in the returned array.
Returns (Group & GroupData)[]
An array of groups.
- Defined in packages/tilmeld/src/Group.ts:449

$getLevel

$getLevel(): number
Get the number of parents the group has.

If the group is a top level group, this will return 0. If it is a child of a top level group, this will return 1. If it is a grandchild of a top level group, this will return 2, and so on.

Levels will max out at 1024 to avoid recursive loops.

Returns number
The level of the group.
- Defined in packages/tilmeld/src/Group.ts:485

$getOriginalAcValues

$getOriginalAcValues(): ACProperties
Returns ACProperties
Inherited from AbleObject.$getOriginalAcValues
- Defined in packages/nymph/dist/Entity.d.ts:43

$getSData

$getSData(): SerializedEntityData
Returns SerializedEntityData
Inherited from AbleObject.$getSData
- Defined in packages/nymph/dist/Entity.d.ts:42

$getTags

$getTags(): string[]
Returns string[]
Inherited from AbleObject.$getTags
- Defined in packages/nymph/dist/Entity.d.ts:45

$getUsers

$getUsers(descendants?, limit?, offset?): Promise<(User & UserData)[]>
Gets an array of users in the group.
Parameters
- descendants: boolean = false
  
  Include users in all descendant groups too.
- Optional limit: number
  
  The limit for the query.
- Optional offset: number
  
  The offset for the query.
Returns Promise<(User & UserData)[]>
An array of users.
- Defined in packages/tilmeld/src/Group.ts:504

$getValidatable

$getValidatable(): any
Returns any
Inherited from AbleObject.$getValidatable
- Defined in packages/nymph/dist/Entity.d.ts:44

$grant

$grant(ability): void
Grant an ability.
Parameters
- ability: string
  
  The ability.
Returns void
Inherited from AbleObject.$grant
- Defined in packages/tilmeld/src/AbleObject.ts:16

$hasTag

$hasTag(...tags): boolean
Parameters
- Rest ...tags: string[]
Returns boolean
Inherited from AbleObject.$hasTag
- Defined in packages/nymph/dist/Entity.d.ts:46

$inArray

$inArray(array, strict?): boolean
Parameters
- array: any[]
- Optional strict: boolean
Returns boolean
Inherited from AbleObject.$inArray
- Defined in packages/nymph/dist/Entity.d.ts:47

$is

$is(object): boolean
Parameters
- object: any
Returns boolean
Inherited from AbleObject.$is
- Defined in packages/nymph/dist/Entity.d.ts:48

$isDescendant

$isDescendant(givenGroup): boolean
Check whether the group is a descendant of a group.
Parameters
- givenGroup: string | Group & GroupData
Returns boolean
True or false.
- Defined in packages/tilmeld/src/Group.ts:374

$jsonAcceptData

$jsonAcceptData(input, allowConflict?): void
Parameters
- input: EntityJson
- allowConflict: boolean = false
Returns void
Overrides AbleObject.$jsonAcceptData
- Defined in packages/tilmeld/src/Group.ts:249

$jsonAcceptPatch

$jsonAcceptPatch(patch, allowConflict?): void
Parameters
- patch: EntityPatch
- allowConflict: boolean = false
Returns void
Overrides AbleObject.$jsonAcceptPatch
- Defined in packages/tilmeld/src/Group.ts:289

$putData

$putData(data, sdata?): void
Parameters
- data: EntityData
- Optional sdata: SerializedEntityData
Returns void
Overrides AbleObject.$putData
- Defined in packages/tilmeld/src/Group.ts:329

`Protected` $referenceSleep

$referenceSleep(reference): void
Parameters
- reference: EntityReference
Returns void
Inherited from AbleObject.$referenceSleep
- Defined in packages/nymph/dist/Entity.d.ts:52

`Protected` $referenceWake

$referenceWake(): boolean
Returns boolean
Inherited from AbleObject.$referenceWake
- Defined in packages/nymph/dist/Entity.d.ts:53

$refresh

$refresh(): Promise<boolean | 0>
Returns Promise<boolean | 0>
Inherited from AbleObject.$refresh
- Defined in packages/nymph/dist/Entity.d.ts:54

$removeTag

$removeTag(...tags): void
Parameters
- Rest ...tags: string[]
Returns void
Inherited from AbleObject.$removeTag
- Defined in packages/nymph/dist/Entity.d.ts:55

$revoke

$revoke(ability): void
Revoke an ability.
Parameters
- ability: string
  
  The ability.
Returns void
Inherited from AbleObject.$revoke
- Defined in packages/tilmeld/src/AbleObject.ts:30

$save

$save(): Promise<boolean>
Returns Promise<boolean>
Overrides AbleObject.$save
- Defined in packages/tilmeld/src/Group.ts:675

$saveSkipAC

$saveSkipAC(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/tilmeld/src/Group.ts:783

$tilmeldSaveSkipAC

$tilmeldSaveSkipAC(): boolean
Returns boolean
- Defined in packages/tilmeld/src/Group.ts:788

$toReference

$toReference(): Group | EntityReference
Returns Group | EntityReference
Inherited from AbleObject.$toReference
- Defined in packages/nymph/dist/Entity.d.ts:57

$updateDataProtection

$updateDataProtection(givenUser?): void
Update the data protection arrays for a user.
Parameters
- Optional givenUser: User & UserData
  
  User to update protection for. If undefined, will use the currently logged in user.
Returns void
- Defined in packages/tilmeld/src/Group.ts:339

$useSkipAc

$useSkipAc(skipAc): void
Parameters
- skipAc: boolean
Returns void
Inherited from AbleObject.$useSkipAc
- Defined in packages/nymph/dist/Entity.d.ts:58

toJSON

toJSON(): null | EntityJson | EntityReference
Returns null | EntityJson | EntityReference
Inherited from AbleObject.toJSON
- Defined in packages/nymph/dist/Entity.d.ts:34

`Static` factory

factory(guid?): Promise<Group & GroupData>
Parameters
- Optional guid: string
Returns Promise<Group & GroupData>
Overrides AbleObject.factory
- Defined in packages/tilmeld/src/Group.ts:118

`Static` factoryGroupname

factoryGroupname(groupname?): Promise<Group & GroupData>
Parameters
- Optional groupname: string
Returns Promise<Group & GroupData>
- Defined in packages/tilmeld/src/Group.ts:122

`Static` factoryReference

factoryReference(reference): new AbleObject<EntityData>
Parameters
- reference: EntityReference
Returns new AbleObject<EntityData>
Inherited from AbleObject.factoryReference
- Defined in packages/nymph/dist/Entity.d.ts:33

`Static` factorySync

factorySync(guid?): Group & GroupData
Parameters
- Optional guid: string
Returns Group & GroupData
Overrides AbleObject.factorySync
- Defined in packages/tilmeld/src/Group.ts:143

`Private` `Static` getAssignableGroups

getAssignableGroups(highestParent, options, selectors): Promise<(Group & GroupData)[]>
Parameters
- highestParent: string | boolean
- options: Options<typeof Group>
- selectors: Selector[]
Returns Promise<(Group & GroupData)[]>
- Defined in packages/tilmeld/src/Group.ts:204

`Static` getPrimaryGroups

getPrimaryGroups(options?, selectors?): Promise<(Group & GroupData)[]>
Get all the groups that can be assigned as primary groups.
Parameters
- Optional options: Options
  
  The options for an optional search query.
- Optional selectors: Selector[]
  
  The selectors for an optional search query.
Returns Promise<(Group & GroupData)[]>
An array of the assignable primary groups.
- Defined in packages/tilmeld/src/Group.ts:165

`Static` getSecondaryGroups

getSecondaryGroups(options?, selectors?): Promise<(Group & GroupData)[]>
Get all the groups that can be assigned as secondary groups.
Parameters
- Optional options: Options
  
  The options for an optional search query.
- Optional selectors: Selector[]
  
  The selectors for an optional search query.
Returns Promise<(Group & GroupData)[]>
An array of the assignable secondary groups.
- Defined in packages/tilmeld/src/Group.ts:188

Class Group

Author

Copyright

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional guid: string

Returns Group

Properties

Protected Optional $allowlistData

Protected Optional $allowlistTags

Protected $clientEnabledMethods

Protected $data

Protected $dataHandler

Protected $dataStore

Protected $isASleepingReference

$nymph

Protected $privateData

Protected $protectedData

Protected $protectedTags

Protected $sdata

Private $skipAcWhenSaving

Protected $sleepingReference

Protected $tags

cdate

guid

mdate

tags

Private Static DEFAULT_ALLOWLIST_DATA

Private Static DEFAULT_PRIVATE_DATA

Static ETYPE

Static class

Static clientEnabledStaticMethods

Static nymph

Static pubSubEnabled

Static restEnabled

Static searchRestrictedData

Methods

$addTag

Parameters

Rest ...tags: string[]

Returns void

$arraySearch

Parameters

array: any[]

Optional strict: boolean

Returns number

$checkEmail

Returns Promise<{ message: string; result: boolean; }>

$checkGroupname

Returns Promise<{ message: string; result: boolean; }>

$clearCache

Returns void

$delete

Returns Promise<boolean>

$equals

Parameters

object: any

Returns boolean

$getAvatar

Returns string

$getChildren

Returns Promise<(Group & GroupData)[]>

$getClientEnabledMethods

Returns string[]

$getData

Parameters

Optional includeSData: boolean

Returns any

$getDescendants

Parameters

andSelf: boolean = false

Returns Promise<(Group & GroupData)[]>

$getDescendantsSync

`Optional` guid: string

`Protected` `Optional` $allowlistData

`Protected` `Optional` $allowlistTags

`Protected` $clientEnabledMethods

`Protected` $data

`Protected` $dataHandler

`Protected` $dataStore

`Protected` $isASleepingReference

`Protected` $privateData

`Protected` $protectedData

`Protected` $protectedTags

`Protected` $sdata

`Private` $skipAcWhenSaving

`Protected` $sleepingReference

`Protected` $tags

`Private` `Static` DEFAULT_ALLOWLIST_DATA

`Private` `Static` DEFAULT_PRIVATE_DATA

`Static` ETYPE

`Static` class

`Static` clientEnabledStaticMethods

`Static` nymph

`Static` pubSubEnabled

`Static` restEnabled

`Static` searchRestrictedData

`Rest` ...tags: string[]

`Optional` strict: boolean

Returns Promise<{
message: string;
result: boolean;
}>

Returns Promise<{
message: string;
result: boolean;
}>

`Optional` includeSData: boolean

`Optional` limit: number

`Optional` offset: number

`Rest` ...tags: string[]

`Optional` strict: boolean

`Optional` sdata: SerializedEntityData

`Protected` $referenceSleep

`Protected` $referenceWake

`Rest` ...tags: string[]