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

  • Type Parameters

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

    Returns AbleObject<T>

Properties

$allowlistData?: string[]
$allowlistTags?: string[]
$clientEnabledMethods: string[]
$data: T
$dataHandler: Object
$dataStore: T
$isASleepingReference: boolean
$nymph: default
$privateData: string[]
$protectedData: string[]
$protectedTags: string[]
$sdata: SerializedEntityData
$sleepingReference: null | EntityReference
$wakePromise: null | Promise<new AbleObject<T>>
cdate: null | number
guid: null | string
mdate: null | number
tags: string[]
ETYPE: string
class: string
clientEnabledStaticMethods: string[]
nymph: default
pubSubEnabled: boolean
restEnabled: boolean
searchRestrictedData: string[]

Methods

  • Parameters

    • Rest ...tags: string[]

    Returns void

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns number

  • Returns boolean

  • Returns void

  • Returns void

  • Returns Promise<boolean>

  • Parameters

    • object: any

    Returns boolean

  • Returns null | string[]

  • Returns null | string

  • Returns null | string[]

  • Returns null | string

  • Returns null | string[]

  • Returns 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
  • Parameters

    • Optional includeSData: boolean

    Returns any

  • Returns ACProperties

  • Returns SerializedEntityData

  • Returns string[]

  • Returns any

  • Parameters

    • Rest ...tags: string[]

    Returns boolean

  • Parameters

    • array: any[]
    • Optional strict: boolean

    Returns boolean

  • Parameters

    • object: any

    Returns boolean

  • Parameters

    • input: EntityJson
    • Optional allowConflict: boolean

    Returns void

  • Parameters

    • patch: EntityPatch
    • Optional allowConflict: boolean

    Returns void

  • Parameters

    • data: EntityData
    • Optional sdata: SerializedEntityData

    Returns void

  • Parameters

    • reference: EntityReference

    Returns void

  • Returns Promise<boolean | 0>

  • Parameters

    • Rest ...tags: string[]

    Returns void

  • Returns Promise<boolean>

  • Returns AbleObject<T> | EntityReference

  • Parameters

    • skipAc: boolean

    Returns void

  • Returns Promise<new AbleObject<T>>

  • Parameters

    • Optional level: number

    Returns Promise<new AbleObject<T>>

  • Returns null | EntityJson | EntityReference

  • Parameters

    • Optional guid: string

    Returns Promise<new AbleObject<EntityData> | EntityInterface>

  • Parameters

    • reference: EntityReference

    Returns new AbleObject<EntityData>

  • Returns new AbleObject<EntityData>

Generated using TypeDoc