Class: API

API

API base class for api implementation.

Constructor

new API()

Source:

Methods

addGuest(profile) → {Promise}

addGuest(profile:Auth.ProfileInfo):Future[Auth.PrimaryProfile] Add a guest account to the system. You will need to pass in the provider type and unique id for that provider. Examples of providers and valid id are: provider: 'email', id: 'user@gmail.com' or provider: 'phone', id: '+1.777.222.1111'
Parameters:
Name Type Description
profile Auth.ProfileInfo profile for the new guest of type 'm.Auth.ProfileInfo'
Source:
Returns:
promise that will be filled with {Auth.PrimaryProfile} This function returns a promise that will be filled with an instance of 'm.Auth.PrimaryProfile' for the guest that was created
Type
Promise

addResponder(type, fun) → {Rx.Subscription}

addResponder The method allows you to register handlers for data of a certain 'type'. When data of this type passes through the stream each of your registered handlers will be called with an opportunity to react on this data.
Parameters:
Name Type Description
type String A String indicating the ES6 class name that you want to subscribe to
fun function The function that will receive data. The data will be instances of the type parameter passed in.
Source:
Returns:
Type
Rx.Subscription

syncUser(sync)

def syncUser(sync:Collaboration.SyncUserEvent):Unit Synchronize user state.
Parameters:
Name Type Description
sync Collaboration.SyncUserEvent The synchronize event to be shared with other users on the system. This parameter is of type 'm.Collaboration.SyncUserEvent'
Source:

syncView(sync)

def syncView(sync:Collaboration.SyncViewEvent):Unit Synchronize view/app state in the synchronization pannel.
Parameters:
Name Type Description
sync m.Collaboration.SyncViewEvent The synchronize event bring application state in sync. This parameter is of type 'm.Collaboration.SyncViewEvent'
Source: