Messangi Cordova SDK

Global

Type Definitions

listBeaconCallback(list)

This callback is invoked when the list of beacons has been successfully loaded in the SDK

Parameters:
Name Type Description
list Array.<Beacon>

Array with all Beacons saved in device

listGeofencesCallback(list)

This callback is invoked when the list of geofences has been successfully loaded in the SDK

Parameters:
Name Type Description
list Array.<Geofence>

Array with all GeoFence saved in device

listMessagesCallback(list)

This callback is invoked when the list of messages has been successfully loaded in the SDK

Parameters:
Name Type Description
list Array.<Message>

Array with all Notification saved in device

sendMessageCallback()

This callback is invoked when an outgoing message has been successfully sent from the app to the ME platform

leaveWorkspaceCallback()

This callback is invoked when the user leaves a workspace

joinWorkspaceCallback(workspace)

This callback is invoked when the user joins a workspace

Parameters:
Name Type Description
workspace Workspace

workspace joined

getWorkspaceCallback(workspace)

This callback is invoked when the user requests a workspace by ID

Parameters:
Name Type Description
workspace Workspace

Workspace

getDefaultWorkspaceCallback(workspace)

This callback is invoked after obtaining the default workspace

Parameters:
Name Type Description
workspace Workspace

Default workspace

getSubscribedWorkspacesCallback(workspace)

This callback is invoked with the list of all the workspaces to which the user is subscribed

Parameters:
Name Type Description
workspace Array.<Workspace>

List of subscribed workspaces

getAvailableWorkspacesCallback(workspace)

This callback returns the list of all the available workspaces to which the user can subscribe

Parameters:
Name Type Description
workspace Array.<Workspace>

List of available workspaces

activatePhoneWithCodeCallback()

This callback is invoked after successfully activating the mobile number

registerWithPhoneCallback()

This callback is invoked after successfully registering the mobile number

registerWithTokenCallback()

This callback is invoked after successfully registering a token

registerCallback()

This callback is invoked after registering the device

getCurrentLocationCallback(location)

This callback is invoked after obtaining the device location

Parameters:
Name Type Description
location Location

Device location

onGeofenceTriggeredCallback(geofence)

This callback is invoked after when Geofence is triggered

Parameters:
Name Type Description
geofence Geofence

Geofence Triggered

onLocationUpdateCallback(location)

This callback is invoked when the location of the device is updated

Parameters:
Name Type Description
location Location

Device location

onPushReceivedCallback(message)

This callback is invoked when a new push notification is received

Parameters:
Name Type Description
message Message

Notification

getUserIDCallback(valid)

This callback is invoked to validate that the user was successfully registered

Parameters:
Name Type Description
valid boolean

true if the user is valid and was successfully registered, false otherwise

getUserIDCallback(userID)

This callback is invoked to obtain the user ID

Parameters:
Name Type Description
userID string

User ID

getUserIDErrorCallback(error)

This callback is invoked if the retrieval of the user ID failed or the user registration is invalid

Parameters:
Name Type Description
error string

Error message

errorCallback(message)

This is the generic error callback, invoked when a generic error occurs in the SDK

Parameters:
Name Type Description
message string

Error message

initCallback()

This callback is invoked after the initialization process is complete successfully