Class AuthenticatingInvitationObservable

Cancelable observer that relays authentication requests.

Hierarchy (View Summary)

CancellableInvitationObservable
- AuthenticatingInvitationObservable

Index

Constructors

constructor

new AuthenticatingInvitationObservable(
    __namedParameters: {
        initialInvitation: Invitation;
        onAuthenticate: (authCode: string) => Promise<void>;
        onCancel: () => Promise<void>;
        subscriber: Observable<Invitation> | Subscriber<Invitation>;
    },
): AuthenticatingInvitationObservable
Parameters
- __namedParameters: {
      initialInvitation: Invitation;
      onAuthenticate: (authCode: string) => Promise<void>;
      onCancel: () => Promise<void>;
      subscriber: Observable<Invitation> | Subscriber<Invitation>;
  }
Returns AuthenticatingInvitationObservable
Overrides CancellableInvitationObservable.constructor
- Defined in packages/sdk/client-protocol/dist/types/src/invitations/invitations.d.ts:30

Properties

`Protected` `Optional`_value

_value?: Invitation

Accessors

expired

get expired(): undefined | boolean
Returns undefined | boolean
Inherited from CancellableInvitation.expired
- Defined in packages/sdk/client-protocol/dist/types/src/invitations/invitations.d.ts:22

expiry

get expiry(): undefined | Date
Returns undefined | Date
Inherited from CancellableInvitation.expiry
- Defined in packages/sdk/client-protocol/dist/types/src/invitations/invitations.d.ts:23

Methods

[observable]

"[observable]"(): Observable<Invitation>
Returns Observable<Invitation>
Inherited from CancellableInvitationObservable.[observable]
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@types/zen-observable/index.d.ts:53

authenticate

authenticate(authCode: string): Promise<void>
Parameters
- authCode: string
Returns Promise<void>
- Defined in packages/sdk/client-protocol/dist/types/src/invitations/invitations.d.ts:36

cancel

cancel(): Promise<void>
Returns Promise<void>
Inherited from CancellableInvitationObservable.cancel
- Defined in packages/sdk/client-protocol/dist/types/src/invitations/invitations.d.ts:21

concat

concat<R>(...observables: Observable<R>[]): MulticastObservable<R>
Type Parameters
- R
Parameters
- ...observables: Observable<R>[]
Returns MulticastObservable<R>
Inherited from CancellableInvitationObservable.concat
- Defined in packages/common/async/dist/types/src/observable.d.ts:40

filter

filter(
callback: (value: Invitation) => boolean,
): MulticastObservable<Invitation>
Parameters
- callback: (value: Invitation) => boolean
Returns MulticastObservable<Invitation>
Inherited from CancellableInvitationObservable.filter
- Defined in packages/common/async/dist/types/src/observable.d.ts:37

flatMap

flatMap<R>(
callback: (value: Invitation) => MulticastObservable<R>,
): MulticastObservable<R>
Type Parameters
- R
Parameters
- callback: (value: Invitation) => MulticastObservable<R>
Returns MulticastObservable<R>
Inherited from CancellableInvitationObservable.flatMap
- Defined in packages/common/async/dist/types/src/observable.d.ts:39

forEach

forEach(callback: (value: Invitation) => void): Promise<void>
Parameters
- callback: (value: Invitation) => void
Returns Promise<void>
Inherited from CancellableInvitationObservable.forEach
- Defined in packages/common/async/dist/types/src/observable.d.ts:35

get

get(): Invitation
Get the current value of the observable.

Returns Invitation
Inherited from CancellableInvitationObservable.get
- Defined in packages/common/async/dist/types/src/observable.d.ts:26

losslessConcat

losslessConcat<R>(
reducer: (currentValue: R, newValues: R[]) => R,
...observables: Observable<R>[],
): MulticastObservable<R>
Concatenates multicast observables without losing the current value.
Type Parameters
- R
Parameters
- reducer: (currentValue: R, newValues: R[]) => R
  reduces the values of any multicast observables being concatenated into a single value
- ...observables: Observable<R>[]
  observables to concatenate
Returns MulticastObservable<R>
concatenated observable
Inherited from CancellableInvitationObservable.losslessConcat
- Defined in packages/common/async/dist/types/src/observable.d.ts:47

map

map<R>(callback: (value: Invitation) => R): MulticastObservable<R>
Type Parameters
- R
Parameters
- callback: (value: Invitation) => R
Returns MulticastObservable<R>
Inherited from CancellableInvitationObservable.map
- Defined in packages/common/async/dist/types/src/observable.d.ts:36

reduce

reduce<R = Invitation>(
callback: (previousValue: R, currentValue: Invitation) => R,
initialValue?: R,
): MulticastObservable<R>
Type Parameters
- R = Invitation
Parameters
- callback: (previousValue: R, currentValue: Invitation) => R
- OptionalinitialValue: R
Returns MulticastObservable<R>
Inherited from CancellableInvitationObservable.reduce
- Defined in packages/common/async/dist/types/src/observable.d.ts:38

subscribe(observer: Observer<Invitation>): Subscription
Parameters
- observer: Observer<Invitation>
Returns Subscription
Inherited from CancellableInvitationObservable.subscribe
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@types/zen-observable/index.d.ts:46
subscribe(
    onNext: (value: Invitation) => void,
    onError?: (error: any) => void,
    onComplete?: () => void,
): Subscription
Parameters
- onNext: (value: Invitation) => void
- OptionalonError: (error: any) => void
- OptionalonComplete: () => void
Returns Subscription
Inherited from CancellableInvitationObservable.subscribe
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@types/zen-observable/index.d.ts:47

wait

wait(__namedParameters?: { timeout?: number }): Promise<Invitation>
Wait for the observable to complete.
Parameters
- Optional__namedParameters: { timeout?: number }
Returns Promise<Invitation>
Promise that resolves to the value of the observable at the time of completion.
Inherited from CancellableInvitationObservable.wait
- Defined in packages/common/async/dist/types/src/observable.d.ts:32

`Static`empty

empty(): MulticastObservable<null>
Returns MulticastObservable<null>
Stable reference to an observable that always returns undefined.
Inherited from CancellableInvitationObservable.empty
- Defined in packages/common/async/dist/types/src/observable.d.ts:22

`Static`from

from<T>(
value: Observable<T> | ObservableLike<T> | ArrayLike<T> | Event<T>,
initialValue?: T,
): MulticastObservable<T>
Type Parameters
- T
Parameters
- value: Observable<T> | ObservableLike<T> | ArrayLike<T> | Event<T>
- OptionalinitialValue: T
Returns MulticastObservable<T>
Inherited from CancellableInvitationObservable.from
- Defined in packages/common/async/dist/types/src/observable.d.ts:17

`Static`of

of<T>(...items: T[]): MulticastObservable<T>
Type Parameters
- T
Parameters
- ...items: T[]
Returns MulticastObservable<T>
Inherited from CancellableInvitationObservable.of
- Defined in packages/common/async/dist/types/src/observable.d.ts:18

Class AuthenticatingInvitationObservable

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AuthenticatingInvitationObservable

Properties

Protected Optional_value

Accessors

expired

Returns undefined | boolean

expiry

Returns undefined | Date

Methods

[observable]

Returns Observable<Invitation>

authenticate

Parameters

Returns Promise<void>

cancel

Returns Promise<void>

concat

Type Parameters

Parameters

Returns MulticastObservable<R>

filter

Parameters

Returns MulticastObservable<Invitation>

flatMap

Type Parameters

Parameters

Returns MulticastObservable<R>

forEach

Parameters

Returns Promise<void>

get

Returns Invitation

losslessConcat

Type Parameters

Parameters

Returns MulticastObservable<R>

map

Type Parameters

Parameters

Returns MulticastObservable<R>

reduce

Type Parameters

Parameters

Returns MulticastObservable<R>

subscribe

Parameters

Returns Subscription

Parameters

Returns Subscription

wait

Parameters

Returns Promise<Invitation>

Staticempty

Returns MulticastObservable<null>

Staticfrom

Type Parameters

Parameters

Returns MulticastObservable<T>

Staticof

Type Parameters

Parameters

Returns MulticastObservable<T>

Settings

On This Page

`Protected` `Optional`_value

`Static`empty

`Static`from

`Static`of