Class Group

Hierarchy

default<GroupData>
- Group

Constructors

constructor

new Group(): Group
Returns Group
Overrides Entity<GroupData>.constructor
- Defined in packages/tilmeld-client/src/Group.ts:67

Properties

`Protected` $data

$data: GroupData

`Protected` $dataHandler

$dataHandler: Object

`Protected` $dataStore

$dataStore: GroupData

`Protected` $dirty

$dirty: {
[k: string]: boolean;
}

Type declaration

[k: string]: boolean

`Protected` $isASleepingReference

$isASleepingReference: boolean

$nymph

$nymph: default

`Protected` $originalTags

$originalTags: string[]

`Protected` $sleepingReference

$sleepingReference: null | EntityReference

`Protected` $wakePromise

$wakePromise: null | Promise<default<GroupData>>

cdate

cdate: null | number

guid

guid: null | string

mdate

mdate: null | number

`Static` class

class: string = 'Group'

`Static` nymph

nymph: default

Methods

$addTag

$addTag(...tags): void
Parameters
- Rest ...tags: string[]
Returns void
Inherited from Entity.$addTag
- Defined in packages/client/lib/Entity.d.ts:29

$arraySearch

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

$asleep

$asleep(): boolean
Returns boolean
Inherited from Entity.$asleep
- Defined in packages/client/lib/Entity.d.ts:39

`Protected` $check

$check(): void
Returns void
Inherited from Entity.$check
- Defined in packages/client/lib/Entity.d.ts:38

$checkEmail

$checkEmail(): Promise<{
message: string;
result: boolean;
}>
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/Group.ts:89

$checkGroupname

$checkGroupname(): Promise<{
message: string;
result: boolean;
}>
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/Group.ts:82

$delete

$delete(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entity.$delete
- Defined in packages/client/lib/Entity.d.ts:31

$equals

$equals(object): boolean
Parameters
- object: any
Returns boolean
Inherited from Entity.$equals
- Defined in packages/client/lib/Entity.d.ts:32

$getAvatar

$getAvatar(): Promise<string>
Returns Promise<string>
- Defined in packages/tilmeld-client/src/Group.ts:93

$getChildren

$getChildren(): Promise<(Group & GroupData)[]>
Returns Promise<(Group & GroupData)[]>
- Defined in packages/tilmeld-client/src/Group.ts:97

$getDescendants

$getDescendants(andSelf?): Promise<(Group & GroupData)[]>
Parameters
- andSelf: boolean = false
Returns Promise<(Group & GroupData)[]>
- Defined in packages/tilmeld-client/src/Group.ts:101

$getLevel

$getLevel(): Promise<number>
Returns Promise<number>
- Defined in packages/tilmeld-client/src/Group.ts:107

$getPatch

$getPatch(): EntityPatch
Returns EntityPatch
Inherited from Entity.$getPatch
- Defined in packages/client/lib/Entity.d.ts:33

$hasTag

$hasTag(...tags): boolean
Parameters
- Rest ...tags: string[]
Returns boolean
Inherited from Entity.$hasTag
- Defined in packages/client/lib/Entity.d.ts:34

$inArray

$inArray(array, strict?): boolean
Parameters
- array: any[]
- Optional strict: boolean
Returns boolean
Inherited from Entity.$inArray
- Defined in packages/client/lib/Entity.d.ts:35

$init

$init(entityJson): default<GroupData>
Parameters
- entityJson: null | EntityJson
Returns default<GroupData>
Inherited from Entity.$init
- Defined in packages/client/lib/Entity.d.ts:28

$is

$is(object): boolean
Parameters
- object: any
Returns boolean
Inherited from Entity.$is
- Defined in packages/client/lib/Entity.d.ts:36

$isDescendant

$isDescendant(givenGroup): Promise<boolean>
Parameters
- givenGroup: string | Group & GroupData
Returns Promise<boolean>
- Defined in packages/tilmeld-client/src/Group.ts:111

$patch

$patch(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entity.$patch
- Defined in packages/client/lib/Entity.d.ts:37

`Protected` $referenceSleep

$referenceSleep(reference): void
Parameters
- reference: EntityReference
Returns void
Inherited from Entity.$referenceSleep
- Defined in packages/client/lib/Entity.d.ts:42

$refresh

$refresh(): Promise<boolean | 0>
Returns Promise<boolean | 0>
Inherited from Entity.$refresh
- Defined in packages/client/lib/Entity.d.ts:43

$removeTag

$removeTag(...tags): void
Parameters
- Rest ...tags: string[]
Returns void
Inherited from Entity.$removeTag
- Defined in packages/client/lib/Entity.d.ts:44

$save

$save(): Promise<boolean>
Returns Promise<boolean>
Inherited from Entity.$save
- Defined in packages/client/lib/Entity.d.ts:45

$serverCall

$serverCall(method, params, stateless?): Promise<any>
Parameters
- method: string
- params: Iterable<any>
- Optional stateless: boolean
Returns Promise<any>
Inherited from Entity.$serverCall
- Defined in packages/client/lib/Entity.d.ts:46

$toReference

$toReference(): EntityReference | EntityInterface
Returns EntityReference | EntityInterface
Inherited from Entity.$toReference
- Defined in packages/client/lib/Entity.d.ts:47

$wake

$wake(): Promise<default<GroupData>>
Returns Promise<default<GroupData>>
Inherited from Entity.$wake
- Defined in packages/client/lib/Entity.d.ts:40

$wakeAll

$wakeAll(level?): Promise<default<GroupData>>
Parameters
- Optional level: number
Returns Promise<default<GroupData>>
Inherited from Entity.$wakeAll
- Defined in packages/client/lib/Entity.d.ts:41

toJSON

toJSON(): EntityJson
Returns EntityJson
Inherited from Entity.toJSON
- Defined in packages/client/lib/Entity.d.ts:27

`Static` factory

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

`Static` factoryReference

factoryReference(reference): default<EntityData>
Parameters
- reference: EntityReference
Returns default<EntityData>
Inherited from Entity.factoryReference
- Defined in packages/client/lib/Entity.d.ts:24

`Static` factorySync

factorySync(): Group & GroupData
Returns Group & GroupData
Overrides Entity.factorySync
- Defined in packages/tilmeld-client/src/Group.ts:78

`Static` getPrimaryGroups

getPrimaryGroups(options?, selectors?): Promise<(Group & GroupData)[]>
Parameters
- Optional options: Options
- Optional selectors: Selector[]
Returns Promise<(Group & GroupData)[]>
- Defined in packages/tilmeld-client/src/Group.ts:117

`Static` getSecondaryGroups

getSecondaryGroups(options?, selectors?): Promise<(Group & GroupData)[]>
Parameters
- Optional options: Options
- Optional selectors: Selector[]
Returns Promise<(Group & GroupData)[]>
- Defined in packages/tilmeld-client/src/Group.ts:127

`Static` serverCallStatic

serverCallStatic(method, params): Promise<any>
Parameters
- method: string
- params: Iterable<any>
Returns Promise<any>
Inherited from Entity.serverCallStatic
- Defined in packages/client/lib/Entity.d.ts:25

`Static` serverCallStaticIterator

serverCallStaticIterator(method, params): Promise<AbortableAsyncIterator<any>>
Parameters
- method: string
- params: Iterable<any>
Returns Promise<AbortableAsyncIterator<any>>
Inherited from Entity.serverCallStaticIterator
- Defined in packages/client/lib/Entity.d.ts:26

Class Group

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Group

Properties

Protected $data

Protected $dataHandler

Protected $dataStore

Protected $dirty

Type declaration

[k: string]: boolean

Protected $isASleepingReference

$nymph

Protected $originalTags

Protected $sleepingReference

Protected $wakePromise

cdate

guid

mdate

tags

Static class

Static nymph

Methods

$addTag

Parameters

Rest ...tags: string[]

Returns void

$arraySearch

Parameters

array: any[]

Optional strict: boolean

Returns number

$asleep

Returns boolean

Protected $check

Returns void

$checkEmail

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

$checkGroupname

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

$delete

Returns Promise<boolean>

$equals

Parameters

object: any

Returns boolean

$getAvatar

Returns Promise<string>

$getChildren

Returns Promise<(Group & GroupData)[]>

$getDescendants

Parameters

andSelf: boolean = false

Returns Promise<(Group & GroupData)[]>

$getLevel

Returns Promise<number>

$getPatch

Returns EntityPatch

$hasTag

Parameters

Rest ...tags: string[]

Returns boolean

$inArray

Parameters

array: any[]

Optional strict: boolean

Returns boolean

$init

Parameters

entityJson: null | EntityJson

Returns default<GroupData>

$is

Parameters

object: any

Returns boolean

`Protected` $data

`Protected` $dataHandler

`Protected` $dataStore

`Protected` $dirty

`Protected` $isASleepingReference

`Protected` $originalTags

`Protected` $sleepingReference

`Protected` $wakePromise

`Static` class

`Static` nymph

`Rest` ...tags: string[]

`Optional` strict: boolean

`Protected` $check

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

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

`Rest` ...tags: string[]

`Optional` strict: boolean

`Protected` $referenceSleep

`Rest` ...tags: string[]

`Optional` stateless: boolean

`Optional` level: number

`Static` factory

`Optional` guid: string

`Static` factoryReference

`Static` factorySync

`Static` getPrimaryGroups

`Optional` options: Options

`Optional` selectors: Selector[]

`Static` getSecondaryGroups

`Optional` options: Options

`Optional` selectors: Selector[]

`Static` serverCallStatic

`Static` serverCallStaticIterator