Protected
Optional
$allowlistProtected
Optional
$allowlistProtected
$clientProtected
$dataProtected
$dataProtected
$dataProtected
$isASleepingProtected
$privateProtected
$protectedProtected
$protectedProtected
$sdataPrivate
$skipThis is explicitly used only during the registration proccess.
Protected
$sleepingProtected
$tagsPrivate
Static
DEFAULT_Private
Static
DEFAULT_Static
ETYPEThe instance of Tilmeld to use for queries.
Static
classStatic
clientStatic
nymphStatic
pubStatic
restStatic
searchGet 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.
The level of the group.
Gets an array of users in the group.
Include users in all descendant groups too.
Optional
limit: numberThe limit for the query.
Optional
offset: numberThe offset for the query.
An array of users.
Protected
$referenceProtected
$referenceStatic
factoryStatic
factoryStatic
factoryStatic
factoryPrivate
Static
getStatic
getGet all the groups that can be assigned as primary groups.
Optional
options: OptionsThe options for an optional search query.
Optional
selectors: Selector[]The selectors for an optional search query.
An array of the assignable primary groups.
Static
getGet all the groups that can be assigned as secondary groups.
Optional
options: OptionsThe options for an optional search query.
Optional
selectors: Selector[]The selectors for an optional search query.
An array of the assignable secondary groups.
Generated using TypeDoc
A user group data model.
Written by Hunter Perrin for SciActive.
Author
Hunter Perrin [email protected]
Copyright
SciActive Inc
See
http://nymph.io/