Connection

interface Connection

This module allows to connect to the Rainbow Cloud Services. Your application will have to use this module to be able to sign-in with the user credentials and to listen to the connection state with the Rainbow Cloud Services.

Types

ConnectionState

enum ConnectionState : Enum<Connection.ConnectionState>

Functions

registerConnectionChangedListener

abstract fun registerConnectionChangedListener(listener: IConnectionChanged)

Register a listener on connection state events

resetCacheAndDatabase

abstract fun resetCacheAndDatabase()

Use this method if you need ot manually reset image cache and database.

signin

abstract fun signin(login: String, password: String, listener: SigninResponseListener?)

Allow to sign-in to Rainbow environment from a Rainbow official user account that already exists.

abstract fun signin(login: String, password: String, host: String, listener: SigninResponseListener?)

Allow to sign-in to Rainbow environment from a Rainbow official user account that already exists.

signinWithOidcToken

abstract fun signinWithOidcToken(token: String, listener: SigninResponseListener?)

Allow to sign-in to Rainbow environment from a Rainbow official user account that already exists.

abstract fun signinWithOidcToken(token: String, host: String?, listener: SigninResponseListener?)

Allow to sign-in to Rainbow environment from a Rainbow official user account that already exists.

signinWithToken

abstract fun signinWithToken(token: String, listener: SigninResponseListener?)

Allow to sign-in to Rainbow environment from a Rainbow official user account that already exists.

abstract fun signinWithToken(token: String, host: String, listener: SigninResponseListener?)

Allow to sign-in to Rainbow environment from a Rainbow official user account that already exists.

signout

abstract fun signout(listener: SignoutResponseListener?)

Allow to sign-out from Rainbow.

unregisterConnectionChangedListener

abstract fun unregisterConnectionChangedListener(listener: IConnectionChanged)

Unregister a listener on connection state events

Properties

isConnected

abstract val isConnected: Boolean

Return true if the current connection state is equals to ConnectionState.RAINBOW_CONNECTIONCONNECTED.

isDisconnected

abstract val isDisconnected: Boolean

Return true if the current connection state is equals to ConnectionState.RAINBOW_CONNECTIONDISCONNECTED.

isInProgress

abstract val isInProgress: Boolean

Return true if the current connection state is equals to ConnectionState.RAINBOW_CONNECTIONINPROGRESS.

state

abstract val state: Connection.ConnectionState

Get the current connection state with the Rainbow Cloud Services.