Class Presence

Presence represents a lightweight presence counter for tracking online users. It provides real-time count updates through the watch stream. It implements Attachable interface to be managed by Attachment.

Implements

Constructors

constructor

Properties

actorID? count eventStream eventStreamObserver key presenceID? seq status

Methods

applyStatus getActorID getCount getKey getPresenceID getStatus hasLocalChanges isAttached publish setActor setPresenceID subscribe updateCount

Constructors

constructor

Properties

Private Optional actorID

actorID?: string

Private count

count: number

Private eventStream

eventStream: Observable<PresenceEvent>

Private eventStreamObserver

eventStreamObserver: Observer<PresenceEvent>

Private key

key: string

Private Optional presenceID

presenceID?: string

Private seq

seq: number

Private status

status: PresenceStatus

Methods

applyStatus

getActorID

  • getActorID(): undefined | string

  • getActorID returns the actor ID of this presence counter.

    Returns undefined | string

getCount

getKey

  • getKey(): string

  • getKey returns the key of this presence counter.

    Returns string

getPresenceID

  • getPresenceID(): undefined | string

  • getPresenceID returns the presence ID from the server.

    Returns undefined | string

getStatus

hasLocalChanges

  • hasLocalChanges(): boolean

  • hasLocalChanges returns whether this presence has local changes or not. Presence is server-managed, so it always returns false.

    Returns boolean

isAttached

  • isAttached(): boolean

  • isAttached returns whether this presence counter is attached or not.

    Returns boolean

publish

  • publish(event): void

  • publish publishes an event to all registered handlers.

    Parameters

    Returns void

setActor

  • setActor(actorID): void

  • setActor sets the actor ID into this presence counter.

    Parameters

    • actorID: string

    Returns void

setPresenceID

  • setPresenceID(presenceID): void

  • setPresenceID sets the presence ID from the server.

    Parameters

    • presenceID: string

    Returns void

subscribe

  • subscribe(observer): Unsubscribe

  • subscribe registers an observer for presence events. Returns an unsubscribe function.

    Parameters

    • observer: ((event) => void)

    Returns Unsubscribe

updateCount

  • updateCount(count, seq): boolean

  • updateCount updates the count and sequence number if the sequence is newer. Returns true if the count was updated, false if the update was ignored.

    Parameters

    • count: number
    • seq: number

    Returns boolean

Settings

Member Visibility

Theme

On This Page

constructoractorIDcounteventStreameventStreamObserverkeypresenceIDseqstatusapplyStatusgetActorIDgetCountgetKeygetPresenceIDgetStatushasLocalChangesisAttachedpublishsetActorsetPresenceIDsubscribeupdateCount