Class User

Hierarchy

  • Model
    • User

Indexable

  • [x: string]: any

Constructors

constructor

Properties

address? admin? ban? blocked? email? expand first_name? founder? friend? installation? language? last_name? last_online? meta name? nickname? organization? other_email? other_sms? parent? phone? provider? public? role? special_token? subuser? subuser_owner? token? verified_email? verified_sms? attributes checker endpoint

Methods

_create addChildrenToStore addOtherMail create delete getAttributes getClass getParent getType getUrl getVersion id loadAllChildren parse parseChild path preserve reload reloadAndParse removeChild restore setParent toJSON update url usePutForUpdate validate fetch fromArray generateOptions getMetaFilterResult me validateMethod

Constructors

constructor

Properties

Optionaladdress

address?: string

Optionaladmin

admin?: boolean

Optionalban

ban?: {
    end_ban: string;
    motivation: string;
    start_ban?: string;
    type: "soft" | "strong";
}

Optionalblocked

blocked?: boolean

Optionalemail

email?: string

expand

expand: number

Optionalfirst_name

first_name?: string

Optionalfounder

founder?: boolean

Optionalfriend

friend?: boolean

Optionalinstallation

installation?: string

Optionallanguage

language?: string

Optionallast_name

last_name?: string

Optionallast_online

last_online?: string

meta

meta: Meta = ...

Optionalname

name?: string

Optionalnickname

nickname?: string

Optionalorganization

organization?: string

Optionalother_email

other_email?: OtherContact[]

Optionalother_sms

other_sms?: OtherContact[]

Optionalparent

parent?: IModel

Optionalphone

phone?: string

Optionalprovider

provider?: { name?: string; picture?: string; type?: string }[]

Optionalpublic

public?: string[]

Optionalrole

role?: string

Optionalspecial_token

special_token?: string

Optionalsubuser

subuser?: boolean

Optionalsubuser_owner

subuser_owner?: string

Optionaltoken

token?: string

Optionalverified_email

verified_email?: boolean

Optionalverified_sms

verified_sms?: boolean

Staticattributes

attributes: string[] = ...

Staticchecker

checker: ICheckerSuite = ...

Staticendpoint

endpoint: string = '/2.1/user'

Methods

_create

addChildrenToStore

  • addChildrenToStore(): void

    Returns void

addOtherMail

  • addOtherMail(contact: string, message: string, language?: string): Promise<void>

    Parameters

    • contact: string
    • message: string
    • language: string = 'en'

    Returns Promise<void>

create

delete

getAttributes

getClass

getParent

getType

getUrl

getVersion

id

loadAllChildren

  • loadAllChildren(json: null | JSONObject, reloadAll?: boolean): Promise<void>

    Parameters

    Returns Promise<void>

parse

parseChild

path

preserve

reload

  • reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>

    Parameters

    • OptionalreloadAll: boolean
    • defaultExpand: number = 0

    Returns Promise<boolean>

reloadAndParse

  • reloadAndParse(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>

    Parameters

    • OptionalreloadAll: boolean
    • defaultExpand: number = 0

    Returns Promise<boolean>

removeChild

restore

setParent

toJSON

update

  • update(customKeys?: string[]): Promise<boolean>

    Parameters

    • OptionalcustomKeys: string[]

    Returns Promise<boolean>

url

ProtectedusePutForUpdate

Protectedvalidate

  • validate(name: string, params: any): void

    Parameters

    • name: string
    • params: any

    Returns void

Staticfetch

StaticfromArray

Protected StaticgenerateOptions

StaticgetMetaFilterResult

Staticme

StaticvalidateMethod

  • validateMethod(
        type: undefined | string,
        name: string,
        params: any,
        isStatic?: boolean,
    ): void

    Parameters

    • type: undefined | string
    • name: string
    • params: any
    • isStatic: boolean = false

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods