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

Constructors

constructor

Properties

$allowlistData? $allowlistTags? $clientEnabledMethods $data $dataHandler $dataStore $isASleepingReference $nymph $privateData $protectedData $protectedTags $sdata $skipAcWhenSaving $sleepingReference $tags $wakePromise cdate guid mdate tags DEFAULT_ALLOWLIST_DATA DEFAULT_PRIVATE_DATA ETYPE class clientEnabledStaticMethods nymph pubSubEnabled restEnabled searchRestrictedData

Methods

$addTag $arraySearch $asleep $check $checkEmail $checkGroupname $clearCache $delete $equals $getAcFullIds $getAcGid $getAcReadIds $getAcUid $getAcWriteIds $getAvatar $getChildren $getClientEnabledMethods $getCurrentAcValues $getData $getDescendants $getLevel $getOriginalAcValues $getSData $getTags $getUsers $getValidatable $grant $hasTag $inArray $is $isDescendant $jsonAcceptData $jsonAcceptPatch $putData $referenceSleep $refresh $removeTag $revoke $save $saveSkipAC $tilmeldSaveSkipAC $toReference $updateDataProtection $useSkipAc $wake $wakeAll toJSON factory factoryGroupname factoryReference factorySync getAssignableGroups getPrimaryGroups getSecondaryGroups

Constructors

constructor

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[] = []

Protected $wakePromise

$wakePromise: null | Promise<new AbleObject<GroupData>>

cdate

cdate: null | number

guid

guid: null | string

mdate

mdate: null | number

tags

tags: string[]

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

$arraySearch

  • $arraySearch(array, strict?): number

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns number

$asleep

  • $asleep(): boolean

  • Returns boolean

Protected $check

  • $check(): void

  • Returns void

$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.

$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.

$clearCache

  • $clearCache(): void

  • Returns void

$delete

$equals

  • $equals(object): boolean

  • Parameters

    • object: any

    Returns boolean

$getAcFullIds

  • $getAcFullIds(): null | string[]

  • Returns null | string[]

$getAcGid

  • $getAcGid(): null | string

  • Returns null | string

$getAcReadIds

  • $getAcReadIds(): null | string[]

  • Returns null | string[]

$getAcUid

  • $getAcUid(): null | string

  • Returns null | string

$getAcWriteIds

  • $getAcWriteIds(): null | string[]

  • Returns null | string[]

$getAvatar

$getChildren

$getClientEnabledMethods

$getCurrentAcValues

  • $getCurrentAcValues(): {
        acFull: null | string[];
        acGroup: any;
        acOther: any;
        acRead: null | string[];
        acUser: any;
        acWrite: null | string[];
        group: null | string;
        user: null | string;
    }

  • Returns {
        acFull: null | string[];
        acGroup: any;
        acOther: any;
        acRead: null | string[];
        acUser: any;
        acWrite: null | string[];
        group: null | string;
        user: null | string;
    }

    • acFull: null | string[]
    • acGroup: any
    • acOther: any
    • acRead: null | string[]
    • acUser: any
    • acWrite: null | string[]
    • group: null | string
    • user: null | string

$getData

  • $getData(includeSData?): any

  • Parameters

    • Optional includeSData: boolean

    Returns any

$getDescendants

$getLevel

  • $getLevel(): Promise<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 Promise<number>

    The level of the group.

$getOriginalAcValues

  • $getOriginalAcValues(): ACProperties

  • Returns ACProperties

$getSData

  • $getSData(): SerializedEntityData

  • Returns SerializedEntityData

$getTags

  • $getTags(): string[]

  • Returns string[]

$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.

$getValidatable

$grant

$hasTag

  • $hasTag(...tags): boolean

  • Parameters

    • Rest ...tags: string[]

    Returns boolean

$inArray

  • $inArray(array, strict?): boolean

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns boolean

$is

  • $is(object): boolean

  • Parameters

    • object: any

    Returns boolean

$isDescendant

$jsonAcceptData

$jsonAcceptPatch

$putData

Protected $referenceSleep

  • $referenceSleep(reference): void

  • Parameters

    • reference: EntityReference

    Returns void

$refresh

  • $refresh(): Promise<boolean | 0>

  • Returns Promise<boolean | 0>

$removeTag

  • $removeTag(...tags): void

  • Parameters

    • Rest ...tags: string[]

    Returns void

$revoke

$save

$saveSkipAC

$tilmeldSaveSkipAC

$toReference

$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

$useSkipAc

  • $useSkipAc(skipAc): void

  • Parameters

    • skipAc: boolean

    Returns void

$wake

$wakeAll

toJSON

  • Returns null | EntityJson | EntityReference

Static factory

Static factoryGroupname

Static factoryReference

Static factorySync

Private Static getAssignableGroups

Static getPrimaryGroups

  • 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.

Static getSecondaryGroups

  • 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc