Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccountSnapshot

The AccountSnapshot class is used to load a "snapshot" of a server-side user account. The snapshot includes all persistent attributes stored in the user account, including room attributes and global attributes.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly target

target: EventDispatcher

Methods

addEventListener

  • addEventListener(type: string, listener: Function, thisArg: any, priority?: number): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any
    • Default value priority: number = 0

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

getAttribute

  • getAttribute(name: string, scope: string): string | null

  • Returns the value of the specified account attribute.

    Parameters

    • name: string

      The attribute's name.

    • scope: string

      The attribute's scope. For global account attributes, specify scope null. For attributes scoped to a room, specify the room's id.

    Returns string | null

getAttributes

  • getAttributes(): {} | null

  • Returns an object whose variables represent the names and values of the shared attributes for this snapshot's account. The object is a map of fully qualified attribute name/value pairs. For details and examples, see Client.getAttributes method, which returns an object of the same format.

    Returns {} | null

    | null}

getListeners

  • getListeners(type: string): EventListener[]

  • Parameters

    • type: string

    Returns EventListener[]

getStatus

  • getStatus(): Status | undefined

  • Returns the status of the most recent snapshot load-operation. If a load operation is currently in progress, getStatus() returns null. The possible return values of getStatus() depend on the snapshot type.

    Returns Status | undefined

getUserID

  • getUserID(): string | null

  • Returns the userID for this user account snapshot object.

    Returns string | null

hasListener

  • hasListener(type: string, listener: Function, thisArg: any): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: Function, thisArg: any): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

updateInProgress

  • updateInProgress(): boolean | undefined

  • Indicates whether the snapshot is currently loading data. While an update is in progress, further requests to update the snapshot are ignored.

    Returns boolean | undefined