Routing

interface Routing

Types

IGetRoutineListener

interface IGetRoutineListener

Interface to get a routine.

Functions

activateNomadic

abstract fun activateNomadic(phoneNumber: String?)

Activate the nomadic on the specified number.

activateRoutine

abstract fun activateRoutine(routineId: String, listener: RainbowListener<Unit, Unit>)

Activate a routine from its id.

areAllDevicesRinging

abstract fun areAllDevicesRinging(): Boolean

Check if all user devices are ringing for incoming calls.

cancelForward

abstract fun cancelForward(forwardType: ForwardType)

Cancel automatic call forwarding depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

deactivateNomadic

abstract fun deactivateNomadic()

Deactivate the nomadic.

forwardToNumber

abstract fun forwardToNumber(number: String?, internal: Boolean, type: ForwardType)

Activate automatic call forwarding to the given number and depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

forwardToVoiceMail

abstract fun forwardToVoiceMail(type: ForwardType)

Activate automatic call forwarding to the voicemail depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

getBusyForwardStatus

abstract fun getBusyForwardStatus(): ForwardStatus?

Get the current Forward status, when you are busy, allowing you to know the destination of your PBX calls.

getDeviceNumber

abstract fun getDeviceNumber(): String?

Get the device GSM phone number (SIM1) if any and if readable.

getForwardStatus

abstract fun getForwardStatus(): ForwardStatus?

Get the current Forward status allowing you to know the destination of your PBX calls.

getNoAnswerForwardStatus

abstract fun getNoAnswerForwardStatus(): ForwardStatus?

Get the current Forward status, when you are not answering, allowing you to know the destination of your PBX calls.

getNomadicNumber

abstract fun getNomadicNumber(withMediapillar: Boolean): String?

Get the nomadic number to use to activate nomadic.

getNomadicStatus

abstract fun getNomadicStatus(): NomadicStatus?

Get the current Nomadic status allowing you to know the destination of your PBX calls.

getRoutineById

abstract fun getRoutineById(routineId: String, listener: Routing.IGetRoutineListener)

Get a specific routine from its id.

getRoutinesList

abstract fun getRoutinesList(): ArrayItemList<Routine>

Get the list of available routines.

getSelectedCliOption

abstract fun getSelectedCliOption(): CLIOptions?

Get the current selected CLI Options for the user.

hasMediaPillar

abstract fun hasMediaPillar(): Boolean

Check if the user has access to VoIP for PBX calls.

hasTelephonyServices

abstract fun hasTelephonyServices(): Boolean

Check if telephony services are up and running (the user will be able handle PBX calls).

modifyRoutine

abstract fun modifyRoutine(routine: Routine, listener: RainbowListener<Unit, Unit>)

Modify a routine.

registerCliChangeListener

abstract fun registerCliChangeListener(listener: RoutingMgr.ICliChangeListener)

registerForwardStatusChangeListener

abstract fun registerForwardStatusChangeListener(listener: RoutingMgr.IForwardStatusChangeListener)

registerNomadicStatusChangeListener

abstract fun registerNomadicStatusChangeListener(listener: RoutingMgr.INomadicStatusChangeListener)

registerRingingDevicesChangeListener

abstract fun registerRingingDevicesChangeListener(listener: RoutingMgr.IRingingDevicesChangeListener)

registerTelephonyServicesChangeListener

abstract fun registerTelephonyServicesChangeListener(listener: RoutingMgr.ITelephonyServicesChangeListener)

retrieveForwardStatus

abstract fun retrieveForwardStatus()

Manually refresh the forward status from server.

retrieveNomadicStatus

abstract fun retrieveNomadicStatus()

Manually refresh the nomadic status from server for Hybrid PBX only.

selectCli

abstract fun selectCli(cliOption: CLIOptions)

Select the new CLI Options to use for identifying external outgoing calls.

unregisterCliChangeListener

abstract fun unregisterCliChangeListener(listener: RoutingMgr.ICliChangeListener)

Unregister the listener on the CLI options change

unregisterForwardStatusChangeListener

abstract fun unregisterForwardStatusChangeListener(listener: RoutingMgr.IForwardStatusChangeListener)

Unregister the listener on the forward change

unregisterNomadicStatusChangeListener

abstract fun unregisterNomadicStatusChangeListener(listener: RoutingMgr.INomadicStatusChangeListener)

Unregister the listener on the nomadic change

unregisterRingingDevicesChangeListener

abstract fun unregisterRingingDevicesChangeListener(listener: RoutingMgr.IRingingDevicesChangeListener)

Unregister the listener on the ringing devices change.

unregisterTelephonyServicesChangeListener

abstract fun unregisterTelephonyServicesChangeListener(listener: RoutingMgr.ITelephonyServicesChangeListener)

Unregister the listener on the telephony services change

updateRingingDevices

abstract fun updateRingingDevices(webRTCOnly: Boolean)

Update ringing devices by activating only VoIP or not.

Properties

cliOptions

abstract val cliOptions: List<CLIOptions>?

Get the list of all CLI Options available for the user.

isDefaultOverflowActivated

abstract val isDefaultOverflowActivated: Boolean

Check if the user has a default overflow activated or not (a forward for BUSY or NO_ANSWER).

isMediaPillarRegistered

abstract val isMediaPillarRegistered: Boolean

Check if VoIP is up and running (the user will be able handle PBX calls through VoIP).

isMultiDevicesUser

abstract val isMultiDevicesUser: Boolean

Check if user has more than one device or not.

isNomadicActivatedOnMediapillar

abstract val isNomadicActivatedOnMediapillar: Boolean

Check if the current nomadic state will let the PBX join the current device running the application through VoIP.

isNomadicActivatedOnMyMobile

abstract val isNomadicActivatedOnMyMobile: Boolean

Check if the current nomadic state will let the PBX join the current device running the application through VoIP or GSM.

isNomadicDeactivatedOnMyMobile

abstract val isNomadicDeactivatedOnMyMobile: Boolean

Check if the current nomadic state will not let the PBX join the current device running the application Always false for Cloud PBX.