Interface IPresence

Hierarchy

IPresence

Index

Methods

initialize emitEvent enable disable isEnabled get list subscribe unsubscribe setStatus enqueue dequeue

Methods

initialize

initialize(): void
Returns void

emitEvent

emitEvent(event: string, payload: IEventPayload): void
Parameters
- event: string
- payload: IEventPayload
Returns void

enable

enable(): Promise<boolean>
Returns Promise<boolean>

disable

disable(): Promise<boolean>
Returns Promise<boolean>

isEnabled

isEnabled(): Promise<boolean>
Returns Promise<boolean>

get

get(personId: string): Promise<IPresenceStatusObject>
Parameters
- personId: string
Returns Promise<IPresenceStatusObject>

list

list(personIds: string[]): Promise<{
statusList: IPresenceStatusObject[];
}>
Parameters
- personIds: string[]
Returns Promise<{
statusList: IPresenceStatusObject[];
}>

subscribe

subscribe(personIds: string | string[], subscriptionTtl?: number): Promise<{
responses: any[];
}>
Parameters
- personIds: string | string[]
- Optional subscriptionTtl: number
Returns Promise<{
responses: any[];
}>

unsubscribe

unsubscribe(personIds: string | string[]): Promise<{
responses: any;
}>
Parameters
- personIds: string | string[]
Returns Promise<{
responses: any;
}>

setStatus

setStatus(status: string, ttl: number): Promise<any>
Parameters
- status: string
- ttl: number
Returns Promise<any>

enqueue

enqueue(id: string): void
Parameters
- id: string
Returns void

dequeue

dequeue(id: string): void
Parameters
- id: string
Returns void