Class AbleObject<T>Abstract

AbleObject abstract class.

Used in entities which support abilities, such as users and groups.

Type Parameters

  • T extends {
        abilities?: string[];
    }

Hierarchy

Constructors

constructor

Properties

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

Methods

$addTag $arraySearch $clearCache $delete $equals $getClientEnabledMethods $getData $getOriginalAcValues $getSData $getTags $getValidatable $grant $hasTag $inArray $is $jsonAcceptData $jsonAcceptPatch $putData $referenceSleep $referenceWake $refresh $removeTag $revoke $save $toReference $useSkipAc toJSON factory factoryReference factorySync

Constructors

constructor

  • Type Parameters

    • T extends {
          abilities?: string[];
      }

    Parameters

    • Optional guid: string

    Returns AbleObject<T>

Properties

Protected Optional $allowlistData

$allowlistData?: string[]

Protected Optional $allowlistTags

$allowlistTags?: string[]

Protected $clientEnabledMethods

$clientEnabledMethods: string[]

Protected $data

$data: T

Protected $dataHandler

$dataHandler: Object

Protected $dataStore

$dataStore: T

Protected $isASleepingReference

$isASleepingReference: boolean

$nymph

$nymph: default

Protected $privateData

$privateData: string[]

Protected $protectedData

$protectedData: string[]

Protected $protectedTags

$protectedTags: string[]

Protected $sdata

$sdata: SerializedEntityData

Protected $sleepingReference

$sleepingReference: null | EntityReference

cdate

cdate: null | number

guid

guid: null | string

mdate

mdate: null | number

tags

tags: string[]

Static ETYPE

ETYPE: string

Static class

class: string

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

$clearCache

  • $clearCache(): void

  • Returns void

$delete

  • $delete(): Promise<boolean>

  • Returns Promise<boolean>

$equals

  • $equals(object): boolean

  • Parameters

    • object: any

    Returns boolean

$getClientEnabledMethods

  • $getClientEnabledMethods(): string[]

  • Returns string[]

$getData

  • $getData(includeSData?): any

  • Parameters

    • Optional includeSData: boolean

    Returns any

$getOriginalAcValues

  • $getOriginalAcValues(): ACProperties

  • Returns ACProperties

$getSData

  • $getSData(): SerializedEntityData

  • Returns SerializedEntityData

$getTags

  • $getTags(): string[]

  • Returns string[]

$getValidatable

  • $getValidatable(): any

  • Returns any

$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

$jsonAcceptData

  • $jsonAcceptData(input, allowConflict?): void

  • Parameters

    • input: EntityJson
    • Optional allowConflict: boolean

    Returns void

$jsonAcceptPatch

  • $jsonAcceptPatch(patch, allowConflict?): void

  • Parameters

    • patch: EntityPatch
    • Optional allowConflict: boolean

    Returns void

$putData

  • $putData(data, sdata?): void

  • Parameters

    • data: EntityData
    • Optional sdata: SerializedEntityData

    Returns void

Protected $referenceSleep

  • $referenceSleep(reference): void

  • Parameters

    • reference: EntityReference

    Returns void

Protected $referenceWake

  • $referenceWake(): boolean

  • Returns boolean

$refresh

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

  • Returns Promise<boolean | 0>

$removeTag

  • $removeTag(...tags): void

  • Parameters

    • Rest ...tags: string[]

    Returns void

$revoke

$save

  • $save(): Promise<boolean>

  • Returns Promise<boolean>

$toReference

  • $toReference(): AbleObject<T> | EntityReference

  • Returns AbleObject<T> | EntityReference

$useSkipAc

  • $useSkipAc(skipAc): void

  • Parameters

    • skipAc: boolean

    Returns void

toJSON

  • Returns null | EntityJson | EntityReference

Static factory

  • Parameters

    • Optional guid: string

    Returns Promise<new AbleObject<EntityData> | EntityInterface>

Static factoryReference

  • Parameters

    • reference: EntityReference

    Returns new AbleObject<EntityData>

Static factorySync

  • Parameters

    • Optional guid: string

    Returns new AbleObject<EntityData>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc