Interface: IObservable

IObservable | Matterport SDK

Usage of the SDK constitutes your agreement with the Matterport SDK Agreement. Email developers@matterport.com with any questions.

A data object that can have its changes observed via subscribing an IObserver or ObserverCallback

Type parameters

DataT

The type of the data being observed.

Hierarchy

IObservable

Index

Methods

Methods

subscribe

subscribe(observer: IObserver<DataT> | ObserverCallback<DataT>): ISubscription

Subscribe to changes on this object. When this observable detects a change, the observer provided will be called with the data associated with this observable.

Parameters
- observer: IObserver<DataT> | ObserverCallback<DataT>
Returns ISubscription

A subscription that can be used to remove the subscribed observer.

waitUntil

waitUntil(condition: ICondition<DataT> | ConditionCallback<DataT>): Promise<DataT>

Wait for a specific condition on this object to be met. When this observable detects a change, the condition provided will be called. When the condition returns true, the returned Promise will be resolved.

Parameters
- condition: ICondition<DataT> | ConditionCallback<DataT>
Returns Promise<DataT>

A promise that is resolved when condition returns true.