Class User

Hierarchy

default<UserData>
- User

Constructors

constructor

new User(): User
Returns User
Overrides Entity<UserData>.constructor
- Defined in packages/tilmeld-client/src/User.ts:181

Properties

`Protected` $data

$data: UserData

`Protected` $dataHandler

$dataHandler: Object

`Protected` $dataStore

$dataStore: UserData

`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<UserData>>

cdate

cdate: null | number

guid

guid: null | string

mdate

mdate: null | number

`Static` class

class: string = 'User'

`Static` nymph

nymph: default

`Protected` `Static` stores

stores: WeakMap<default, InstanceStore> = ...

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

$changePassword

$changePassword(data): Promise<{
message: string;
result: boolean;
}>
Parameters
- data: {
      currentPassword: string;
      newPassword: string;
      revokeCurrentTokens?: boolean;
  }
  - currentPassword: string
  - newPassword: string
  - Optional revokeCurrentTokens?: boolean
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:313

`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/User.ts:224

$checkPhone

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

$checkUsername

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

$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

$gatekeeper

$gatekeeper(ability?): Promise<boolean>
Parameters
- Optional ability: string
Returns Promise<boolean>
- Defined in packages/tilmeld-client/src/User.ts:309

$getAvatar

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

$getNewTOTPSecret

$getNewTOTPSecret(): Promise<{
    qrcode: string;
    secret: string;
    uri: string;
}>
Returns Promise<{
    qrcode: string;
    secret: string;
    uri: string;
}>
- Defined in packages/tilmeld-client/src/User.ts:331

$getPatch

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

$hasTOTPSecret

$hasTOTPSecret(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/tilmeld-client/src/User.ts:327

$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<UserData>
Parameters
- entityJson: null | EntityJson
Returns default<UserData>
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

$logout

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

$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

$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;
}>
- Defined in packages/tilmeld-client/src/User.ts:242

$removeTOTPSecret

$removeTOTPSecret(data): Promise<{
message: string;
result: boolean;
}>
Parameters
- data: {
  code: string;
  password: string;
  }
  - code: string
  - password: string
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:347

$removeTag

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

$revokeCurrentTokens

$revokeCurrentTokens(data): Promise<{
message: string;
result: boolean;
}>
Parameters
- data: {
  password: string;
  }
  - password: string
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:321

$save

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

$saveTOTPSecret

$saveTOTPSecret(data): Promise<{
message: string;
result: boolean;
}>
Parameters
- data: {
      code: string;
      password: string;
      secret: string;
  }
  - code: string
  - password: string
  - secret: string
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:339

$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

$switchUser

$switchUser(data?): Promise<{
message: string;
result: boolean;
}>
Parameters
- Optional data: {
      additionalData?: {
          [k: string]: any;
      };
  }
  - Optional additionalData?: {
    [k: string]: any;
    }
    - [k: string]: any
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:268

$toReference

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

$wake

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

$wakeAll

$wakeAll(level?): Promise<default<UserData>>
Parameters
- Optional level: number
Returns Promise<default<UserData>>
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` current

current(returnObjectIfNotExist): Promise<User & UserData & {
    abilities?: string[];
    email?: string;
    group?: Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    };
    groups?: (Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    })[];
    inheritAbilities?: boolean;
    newEmailAddress?: string;
    phone?: string;
}>
Parameters
- returnObjectIfNotExist: true
Returns Promise<User & UserData & {
    abilities?: string[];
    email?: string;
    group?: Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    };
    groups?: (Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    })[];
    inheritAbilities?: boolean;
    newEmailAddress?: string;
    phone?: string;
}>
- Defined in packages/tilmeld-client/src/User.ts:354
current(returnObjectIfNotExist?): Promise<null | User & UserData & {
    abilities?: string[];
    email?: string;
    group?: Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    };
    groups?: (Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    })[];
    inheritAbilities?: boolean;
    newEmailAddress?: string;
    phone?: string;
}>
Parameters
- Optional returnObjectIfNotExist: false
Returns Promise<null | User & UserData & {
    abilities?: string[];
    email?: string;
    group?: Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    };
    groups?: (Group & GroupData & {
        abilities?: string[];
        email?: string;
        phone?: string;
        user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
    })[];
    inheritAbilities?: boolean;
    newEmailAddress?: string;
    phone?: string;
}>
- Defined in packages/tilmeld-client/src/User.ts:357

`Static` factory

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

`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(): User & UserData
Returns User & UserData
Overrides Entity.factorySync
- Defined in packages/tilmeld-client/src/User.ts:213

`Static` factoryUsername

factoryUsername(username?): Promise<User & UserData>
Parameters
- Optional username: string
Returns Promise<User & UserData>
- Defined in packages/tilmeld-client/src/User.ts:194

`Static` getClientConfig

getClientConfig(): Promise<ClientConfig>
Returns Promise<ClientConfig>
- Defined in packages/tilmeld-client/src/User.ts:413

`Private` `Static` handleToken

handleToken(response?): void
Parameters
- Optional response: Response
Returns void
- Defined in packages/tilmeld-client/src/User.ts:437

`Static` init

init(nymph): void
Parameters
- nymph: default
Returns void
- Defined in packages/tilmeld-client/src/User.ts:155

`Static` loginUser

loginUser(data): Promise<{
    message: string;
    needTOTP?: true;
    result: boolean;
    user?: User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
        };
        groups?: (Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
        })[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    };
}>
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?: true;
    result: boolean;
    user?: User & UserData & {
        abilities?: string[];
        email?: string;
        group?: Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
        };
        groups?: (Group & GroupData & {
            abilities?: string[];
            email?: string;
            phone?: string;
            user?: null | User & UserData & ({ abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; groups?: (Group & ......);
        })[];
        inheritAbilities?: boolean;
        newEmailAddress?: string;
        phone?: string;
    };
}>
- Defined in packages/tilmeld-client/src/User.ts:370

`Static` off

off<T>(event, callback): boolean
Type Parameters
- T extends EventType
Parameters
- event: T
- callback: T extends "register"
      ? RegisterCallback
      : T extends "login"
          ? LoginCallback
          : T extends "logout"
              ? LogoutCallback
              : never
Returns boolean
- Defined in packages/tilmeld-client/src/User.ts:514

`Static` on

on<T>(event, callback): (() => boolean)
Type Parameters
- T extends EventType
Parameters
- event: T
- callback: T extends "register"
      ? RegisterCallback
      : T extends "login"
          ? LoginCallback
          : T extends "logout"
              ? LogoutCallback
              : never
Returns (() => boolean)
- - (): boolean
  - Returns boolean
- Defined in packages/tilmeld-client/src/User.ts:482

`Static` recover

recover(data): Promise<{
message: string;
result: boolean;
}>
Parameters
- data: {
      password: string;
      secret: string;
      username: string;
  }
  - password: string
  - secret: string
  - username: string
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:405

`Static` sendRecovery

sendRecovery(data): Promise<{
message: string;
result: boolean;
}>
Parameters
- data: {
  account: string;
  recoveryType: "username" | "password";
  }
  - account: string
  - recoveryType: "username" | "password"
Returns Promise<{
message: string;
result: boolean;
}>
- Defined in packages/tilmeld-client/src/User.ts:398

`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 User

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns User

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

Protected Static stores

Methods

$addTag

Parameters

Rest ...tags: string[]

Returns void

$arraySearch

Parameters

array: any[]

Optional strict: boolean

Returns number

$asleep

Returns boolean

$changePassword

Parameters

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

currentPassword: string

newPassword: string

Optional revokeCurrentTokens?: boolean

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

Protected $check

Returns void

$checkEmail

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

$checkPhone

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

$checkUsername

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

$delete

Returns Promise<boolean>

$equals

Parameters

object: any

Returns boolean

$gatekeeper

Parameters

Optional ability: string

Returns Promise<boolean>

$getAvatar

Returns Promise<string>

$getNewTOTPSecret

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

$getPatch

Returns EntityPatch

$hasTOTPSecret

Returns Promise<boolean>

$hasTag

Parameters

Rest ...tags: string[]

Returns boolean

$inArray

Parameters

array: any[]

`Protected` $data

`Protected` $dataHandler

`Protected` $dataStore

`Protected` $dirty

`Protected` $isASleepingReference

`Protected` $originalTags

`Protected` $sleepingReference

`Protected` $wakePromise

`Static` class

`Static` nymph

`Protected` `Static` stores

`Rest` ...tags: string[]

`Optional` strict: boolean

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

`Optional` revokeCurrentTokens?: boolean

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

`Protected` $check

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

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

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

`Optional` ability: string

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

`Rest` ...tags: string[]

`Optional` strict: boolean

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

`Protected` $referenceSleep

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

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

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

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

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

`Rest` ...tags: string[]

data: {
password: string;
}

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

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

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

`Optional` stateless: boolean

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

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

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

`Optional` level: number