Interface PresenceSubscription

A live presence subscription yielding PresenceNotifications.

interface PresenceSubscription {
    "[asyncDispose]"(): PromiseLike<void>;
    "[asyncIterator]"(): AsyncIterator<PresenceNotification, any, any>;
    unsubscribe(): Promise<void>;
}

Hierarchy

AsyncIterable<PresenceNotification>
AsyncDisposable
- PresenceSubscription

Index

Methods

[asyncDispose] [asyncIterator] unsubscribe

Methods

[asyncDispose]

"[asyncDispose]"(): PromiseLike<void>
Returns PromiseLike<void>
Inherited from AsyncDisposable.[asyncDispose]
- Defined in node_modules/typescript/lib/lib.esnext.disposable.d.ts:38

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<PresenceNotification, any, any>
Returns AsyncIterator<PresenceNotification, any, any>
Inherited from AsyncIterable.[asyncIterator]
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36

unsubscribe

unsubscribe(): Promise<void>
Ends the subscription (SUBSCRIBE with Expires: 0).

Returns Promise<void>
- Defined in src/sip/index.ts:150