Skip to main content

Class CancellableInvitationObservable

About 1 min

Class CancellableInvitationObservable

Declared in packages/sdk/client-protocol/dist/types/src/invitations/invitations.d.ts:14

Base class for all invitation observables and providers.

Constructors

constructor(options)

Returns: CancellableInvitation

Arguments:

options: object

Properties

_value

Type: Invitation

expired

Type: undefined | boolean | "0"

expiry

Type: undefined | Date

Methods

[observable]()

Returns: Observable<Invitation>

Arguments: none

cancel()

Returns: Promise<void>

Arguments: none

concat(observables)

Returns: MulticastObservable<R>

Arguments:

observables: Observable<R>[]

filter(callback)

Returns: MulticastObservable<Invitation>

Arguments:

callback: function

flatMap(callback)

Returns: MulticastObservable<R>

Arguments:

callback: function

forEach(callback)

Returns: Promise<void>

Arguments:

callback: function

get()

Get the current value of the observable.

Returns: Invitation

Arguments: none

losslessConcat(reducer, observables)

Concatenates multicast observables without losing the current value.

Returns: MulticastObservable<R>

Arguments:

reducer: function

observables: Observable<R>[]

map(callback)

Returns: MulticastObservable<R>

Arguments:

callback: function

reduce(callback, [initialValue])

Returns: MulticastObservable<R>

Arguments:

callback: function

initialValue: R

subscribe(onNext, [onError], [onComplete])

Returns: Subscription

Arguments:

onNext: function

onError: function

onComplete: function

wait([options])

Wait for the observable to complete.

Returns: Promise<Invitation>

Arguments:

options: object

empty()

Returns: MulticastObservable<"null">

Arguments: none

from(value, [initialValue])

Returns: MulticastObservable<T>

Arguments:

value: Observable<T> | ObservableLike<T> | ArrayLike<T> | Event<T>

initialValue: T

of(items)

Returns: MulticastObservable<T>

Arguments:

items: T[]