Class User

A user 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 $descendantGroups? $gatekeeperCache? $isASleepingReference $nymph $originalEmail? $privateData $protectedData $protectedTags $sdata $skipAcWhenSaving $sleepingReference $wakePromise cdate guid mdate tags DEFAULT_ALLOWLIST_DATA DEFAULT_CLIENT_ENABLED_METHODS DEFAULT_PRIVATE_DATA ETYPE afterLoginCallbacks afterLogoutCallbacks afterRegisterCallbacks beforeLoginCallbacks beforeLogoutCallbacks beforeRegisterCallbacks checkUsernameCallbacks class clientEnabledStaticMethods nymph pubSubEnabled restEnabled searchRestrictedData

Methods

$addGroup $addTag $arraySearch $asleep $changePassword $check $checkEmail $checkPassword $checkPhone $checkTOTPCode $checkUsername $clearCache $delGroup $delete $equals $gatekeeper $getAcFullIds $getAcGid $getAcReadIds $getAcUid $getAcWriteIds $getAvatar $getClientEnabledMethods $getCurrentAcValues $getData $getDescendantGroups $getGatekeeperCache $getGid $getGids $getNewTOTPSecret $getOriginalAcValues $getSData $getTags $getValidatable $grant $hasTOTPSecret $hasTag $inArray $inGroup $is $isDescendant $jsonAcceptData $jsonAcceptPatch $login $logout $password $putData $referenceSleep $refresh $register $removeTOTPSecret $removeTag $revoke $revokeCurrentTokens $save $saveSkipAC $saveTOTPSecret $sendEmailVerification $switchUser $tilmeldSaveSkipAC $toReference $updateDataProtection $updateGroupDataProtection $useSkipAc $wake $wakeAll toJSON current factory factoryReference factorySync factoryUsername getClientConfig loginUser off on recover sendRecovery

Constructors

constructor

Properties

Protected Optional $allowlistData

$allowlistData?: string[] = ...

Protected Optional $allowlistTags

$allowlistTags?: string[] = []

Protected $clientEnabledMethods

$clientEnabledMethods: string[] = ...

Protected $data

$data: UserData

Protected $dataHandler

$dataHandler: Object

Protected $dataStore

$dataStore: UserData

Private Optional $descendantGroups

$descendantGroups?: (Group & GroupData)[]

The user's group descendants.

Private Optional $gatekeeperCache

$gatekeeperCache?: {
    [k: string]: true;
}

Gatekeeper ability cache.

Gatekeeper will cache the user's abilities that it calculates, so it can check faster if that user has been checked before.

Type declaration

  • [k: string]: true

Protected $isASleepingReference

$isASleepingReference: boolean

$nymph

$nymph: default

Optional $originalEmail

$originalEmail?: string

Used to save the current email address to send verification if it changes from the frontend.

If you are changing a user's email address and want to bypass email verification, don't set this.

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

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

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_CLIENT_ENABLED_METHODS

DEFAULT_CLIENT_ENABLED_METHODS: string[] = ...

Private Static DEFAULT_PRIVATE_DATA

DEFAULT_PRIVATE_DATA: string[] = ...

Static ETYPE

ETYPE: string = 'tilmeld_user'

The instance of Tilmeld to use for queries.

Private Static afterLoginCallbacks

afterLoginCallbacks: TilmeldAfterLoginCallback[] = []

Private Static afterLogoutCallbacks

afterLogoutCallbacks: TilmeldAfterLogoutCallback[] = []

Private Static afterRegisterCallbacks

afterRegisterCallbacks: TilmeldAfterRegisterCallback[] = []

Private Static beforeLoginCallbacks

beforeLoginCallbacks: TilmeldBeforeLoginCallback[] = []

Private Static beforeLogoutCallbacks

beforeLogoutCallbacks: TilmeldBeforeLogoutCallback[] = []

Private Static beforeRegisterCallbacks

beforeRegisterCallbacks: TilmeldBeforeRegisterCallback[] = []

Private Static checkUsernameCallbacks

checkUsernameCallbacks: TilmeldCheckUsernameCallback[] = []

Static class

class: string = 'User'

Static clientEnabledStaticMethods

clientEnabledStaticMethods: string[] = ...

Static nymph

nymph: default

Static pubSubEnabled

pubSubEnabled: boolean

Static restEnabled

restEnabled: boolean

Static searchRestrictedData

searchRestrictedData: string[] = ...

Methods

$addGroup

$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

$changePassword

  • $changePassword(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to change the user's password.

    Parameters

    • data: {
          currentPassword: string;
          newPassword: string;
          revokeCurrentTokens?: boolean;
      }

      The input data from the client.

      • currentPassword: string
      • newPassword: string
      • Optional revokeCurrentTokens?: boolean

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

    An object with a boolean 'result' entry and a 'message' entry.

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.

$checkPassword

  • $checkPassword(password): boolean

  • Check the given password against the user's.

    Parameters

    • password: string

      The password in question.

    Returns boolean

    True if the passwords match, otherwise false.

$checkPhone

  • $checkPhone(): Promise<{
        message: string;
        result: boolean;
    }>

  • Check that a phone number is unique.

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

    An object with a boolean 'result' entry and a 'message' entry.

$checkTOTPCode

  • $checkTOTPCode(code): boolean

  • Check the given code against the user's TOTP secret.

    Parameters

    • code: string

      The code in question.

    Returns boolean

    True if the code is valid, otherwise false.

$checkUsername

  • $checkUsername(): Promise<{
        message: string;
        result: boolean;
    }>

  • Check that a username is valid.

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

    An object with a boolean 'result' entry and a 'message' entry.

$clearCache

$delGroup

$delete

$equals

  • $equals(object): boolean

  • Parameters

    • object: any

    Returns boolean

$gatekeeper

  • $gatekeeper(ability?): Promise<boolean>

  • Check to see if a user has an ability.

    This function will check both user and group abilities, if the user is marked to inherit the abilities of its group.

    If ability is undefined, it will check to see if the user is currently logged in.

    If the user has the "system/admin" ability, this function will return true.

    Parameters

    • Optional ability: string

      The ability.

    Returns Promise<boolean>

    True or false.

$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

$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

$getDescendantGroups

$getGatekeeperCache

  • $getGatekeeperCache(): Promise<{
        [k: string]: T;
    }>

  • Build a gatekeeper cache object.

    Returns Promise<{
        [k: string]: T;
    }>

$getGid

$getGids

$getNewTOTPSecret

  • $getNewTOTPSecret(): Promise<{
        qrcode: string;
        secret: string;
        uri: string;
    }>

  • A frontend accessible method to generate a new TOTP secret.

    Returns Promise<{
        qrcode: string;
        secret: string;
        uri: string;
    }>

    An object with 'uri', 'qrcode', and 'secret'.

$getOriginalAcValues

  • $getOriginalAcValues(): ACProperties

  • Returns ACProperties

$getSData

  • $getSData(): SerializedEntityData

  • Returns SerializedEntityData

$getTags

  • $getTags(): string[]

  • Returns string[]

$getValidatable

$grant

$hasTOTPSecret

$hasTag

  • $hasTag(...tags): boolean

  • Parameters

    • Rest ...tags: string[]

    Returns boolean

$inArray

  • $inArray(array, strict?): boolean

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns boolean

$inGroup

  • $inGroup(group): Promise<boolean>

  • Check whether the user is in a (primary or secondary) group.

    Parameters

    Returns Promise<boolean>

    True or false.

$is

  • $is(object): boolean

  • Parameters

    • object: any

    Returns boolean

$isDescendant

  • $isDescendant(group): Promise<boolean>

  • Check whether the user is a descendant of a group.

    Parameters

    Returns Promise<boolean>

    True or false.

$jsonAcceptData

$jsonAcceptPatch

$login

  • $login(data): Promise<{
        message: string;
        needTOTP: boolean;
        result: boolean;
    } | {
        message: any;
        needTOTP?: undefined;
        result: boolean;
    }>

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          code?: string;
          password: string;
          username: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • Optional code?: string
      • password: string
      • username: string

    Returns Promise<{
        message: string;
        needTOTP: boolean;
        result: boolean;
    } | {
        message: any;
        needTOTP?: undefined;
        result: boolean;
    }>

$logout

  • $logout(): Promise<{
        message: any;
        result: boolean;
    }>

  • Log a user out of the system.

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

    An object with a boolean 'result' entry and a 'message' entry.

$password

  • $password(password): string

  • Change the user's password.

    Parameters

    • password: string

      The new password.

    Returns string

    The resulting password or hash which is stored in the entity.

$putData

Protected $referenceSleep

  • $referenceSleep(reference): void

  • Parameters

    • reference: EntityReference

    Returns void

$refresh

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

  • Returns Promise<boolean | 0>

$register

  • $register(data): Promise<{
        loggedin: boolean;
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          password: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • password: string

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

$removeTOTPSecret

  • $removeTOTPSecret(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to remove the TOTP secret from the user's account.

    Parameters

    • data: {
          code: string;
          password: string;
      }

      The input data from the client.

      • code: string
      • password: string

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

    An object with a boolean 'result' entry and a 'message' entry.

$removeTag

  • $removeTag(...tags): void

  • Parameters

    • Rest ...tags: string[]

    Returns void

$revoke

$revokeCurrentTokens

  • $revokeCurrentTokens(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to revoke all currently issued tokens.

    Parameters

    • data: {
          password: string;
      }

      The input data from the client.

      • password: string

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

    An object with a boolean 'result' entry and a 'message' entry.

$save

$saveSkipAC

$saveTOTPSecret

  • $saveTOTPSecret(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to save a TOTP secret into the user's account.

    Parameters

    • data: {
          code: string;
          password: string;
          secret: string;
      }

      The input data from the client.

      • code: string
      • password: string
      • secret: string

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

    An object with a boolean 'result' entry and a 'message' entry.

$sendEmailVerification

  • $sendEmailVerification(): Promise<boolean>

  • Send the user email verification/change/cancellation links.

    Returns Promise<boolean>

    True on success, false on failure.

$switchUser

  • $switchUser(data?): Promise<{
        message: any;
        result: boolean;
    }>

  • Parameters

    • Optional data: {
          additionalData?: {
              [k: string]: any;
          };
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any

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

$tilmeldSaveSkipAC

$toReference

  • $toReference(): User | EntityReference

  • Returns User | EntityReference

$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

$updateGroupDataProtection

$useSkipAc

  • $useSkipAc(skipAc): void

  • Parameters

    • skipAc: boolean

    Returns void

$wake

$wakeAll

toJSON

  • Returns null | EntityJson | EntityReference

Static current

Static factory

Static factoryReference

Static factorySync

Static factoryUsername

Static getClientConfig

  • Returns {
        allowRegistration: boolean;
        allowUsernameChange: boolean;
        emailUsernames: boolean;
        pwRecovery: boolean;
        regFields: string[];
        unverifiedAccess: boolean;
        userFields: string[];
        verifyEmail: boolean;
    }

    • allowRegistration: boolean
    • allowUsernameChange: boolean
    • emailUsernames: boolean
    • pwRecovery: boolean
    • regFields: string[]
    • unverifiedAccess: boolean
    • userFields: string[]
    • verifyEmail: boolean

Static loginUser

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          code?: string;
          password: string;
          username: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • Optional code?: string
      • password: string
      • username: string

    Returns Promise<{
        message: string;
        result: boolean;
        user?: User & UserData;
    }>

Static off

Static on

Static recover

  • Recover account details.

    Parameters

    • data: {
          password: string;
          secret: string;
          username: string;
      }

      The input data from the client.

      • password: string
      • secret: string
      • username: string

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

    An object with a boolean 'result' entry and a 'message' entry.

Static sendRecovery

  • Send an account recovery link.

    Parameters

    • data: {
          account: string;
          recoveryType: "password" | "username";
      }

      The input data from the client.

      • account: string
      • recoveryType: "password" | "username"

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

    An object with a boolean 'result' entry and a 'message' entry.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc