This plugin provides Hybrid Messaging SDK functionality for cordova based apps.
Latest version is 1.0.0
- cordova plugin add https://github.com/CMTelecom/cm-plugin-hybridmessaging.git#1.0.0
- Android
- iOS
- hybridmessaging.configureService
- hybridmessaging.startMessagingService
- hybridmessaging.requestVerification
- hybridmessaging.verifyPin
- hybridmessaging.requestVerificationVoiceCall
- hybridmessaging.getVerificationStatus
- hybridmessaging.getMessages
- hybridmessaging.getDeviceIdValue
- hybridmessaging.getMsisdnValue
- hybridmessaging.setDevelopment
Configures the hybrid messaging service with API key, API secret, Android sender ID and relevant callbacks
IMPORTANT: the configureService method should be called as early in the application's life cycle as possible and prior to executing any other call related to hybrid messaging. All hybrid messaging methods called prior to service configuration will return with an error.
- config:
Object, (required) - config object with format:
{
appKey : 'string',
appSecret : 'string',
senderId : 'string', (required on Android only)
notificationCallback : 'function',
deviceCarrierUpdateCallback : 'function'
}function notificationCallback(pushPayload) {
console.log(pushPayload);
#push payload is raw platform-specific payload including keys such as 'alert' on iOS and 'message' on Android.
var message = pushPayload.alert ? pushPayload.alert : pushPayload.message;
$cordovaDialogs.alert(message, 'Push message', 'OK');
}
function deviceCarrierUpdateCallback() {
console.log('Device carrier has changed');
}
var config = {
appKey : YOUR_APP_KEY,
appSecret : YOUR_APP_SECRET,
senderId : YOUR_ANDROID_SENDER_ID,
notificationCallback: notificationCallback,
deviceCarrierUpdateCallback: deviceCarrierUpdateCallback
};
window.hybridmessaging.configureService(config);Enables the hybrid messaging service
IMPORTANT: the startMessagingService method should be called after executing the configureService method and should complete with success prior to executing any other call related to hybrid messaging. All hybrid messaging methods called prior to successful service starting (except for configureService which should be called before it and as early in the application life cycle as possible) will return with an error.
-
successCallback:
function, (required) - callback function to be called upon successfully started messaging service -
failureCallback:
function, (optional) - callback function to be called upon error
window.hybridmessaging.startMessagingService(function() {
console.log('Messaging service has started successfully');
}, function(error) {
console.log('Failed to start messaging service: ' + error);
});Requests the phone number verification. Returns current DeviceRegistrationStatus in successful callback
IMPORTANT: in order to be able to receive hybrid messaging notifications and to be able to fetch older messages from the server, the device's phone number (MSISDN) has to be verified at least once after the app's installation. Default phone number verification method is by the means of sending a one-time PIN via SMS.
-
msisdn:
string, (required) - phone number to verify -
successCallback:
function, (required) - callback function to be called upon successfully requesting number verification -
failureCallback:
function, (optional) - callback function to be called upon error
var msisdn = '0031612345678';
window.hybridmessaging.requestVerification(msisdn, function(status) {
console.log(status);
}, function(error) {
console.log('Phone number verification failed: ' + error);
});Verifies the PIN typically entered by the user after previously receiving it in an SMS for the purpose of phone number verification. Returns current DeviceRegistrationStatus in successful callback
-
pin:
string, (required) - pin to verify -
successCallback:
function, (required) - callback function to be called upon successfully executing PIN verification (with verification either passed or failed, but in any case correctly executed) -
errorCallback:
function, (optional) - callback function to be called upon error
var pin = '0785';
window.hybridmessaging.verifyPin(pin, function(status) {
console.log(status);
}, function(error) {
console.log('Failed to verify pin: ' + error);
});Requests the phone number verification via voice call. Typically serves as a fallback in case if the default SMS-based number verification failed e.g. due to network issues. The requested voice call, if successful, will provide the same PIN code as was originally sent via SMS.
IMPORTANT: Due to its fallback nature the requestVerificationVoiceCall method should only be called after regular SMS-based verification has been requested using the requestVerification method. Calling requestVerificationVoiceCall before attempting at least one requestVerification call in the application's life cycle will result in an error.
-
successCallback:
function, (required) - callback function to be called upon successfully requesting PIN voice call -
errorCallback:
function, (optional) - callback function to be called upon error
window.hybridmessaging.requestVerificationVoiceCall(function() {
console.log('Successfully performed a voice call');
}, function(error) {
console.log('Failed to perform a voice call: ' + error);
});Requests current verification status. Returns current DeviceRegistrationStatus in successful callback
-
successCallback:
function, (required) - callback function to be called upon successfully fetching the current status -
errorCallback:
function, (optional) - callback function to be called upon error
window.hybridmessaging.getVerificationStatus(function(status) {
console.log(status);
}, function(error) {
console.log('Failed to get verification status: ' + error);
});Returns the messages that have been sent to the particular MSISDN number using Hybrid Messaging (either all of them ever since the number has been registered with Hybrid Messaging or a subset of those depending on the provided limit and offset values)
-
limit:
number, (optional) - amount of messages to retrieve -
offset:
number, (optional) - offset from which messages to retrieve -
successCallback:
function, (required) - callback to be called upon successful message retrieval -
errorCallback:
function, (optional) - callback function to be called upon error
var limit = 5;
var offset = 10;
window.hybridmessaging.getMessages(limit, offset, function(messages) {
console.log(messages);
}, function(error) {
console.log('Failed to retrieve messages: ' + error);
});Returns a device ID value as used by the Hybrid Messaging system for device identification
-
successCallback:
function, (required) - callback function to be called upon successfully fetching device ID -
errorCallback:
function, (optional) - callback function to be called upon error
window.hybridmessaging.getDeviceIdValue(function(deviceId) {
console.log('Device id is ' + deviceId);
}, function(error) {
console.log('Failed to fetch device id: ' + error);
});Returns the value of the msisdn number registered with the hybrid messaging system
-
successCallback:
function, (required) - callback function to be called upon successfully fetching MSISDN -
errorCallback:
function, (optional) - callback function to be called upon error
window.hybridmessaging.getMsisdnValue(function(msisdn) {
console.log('MSISDN is ' + msisdn);
}, function(error) {
console.log('Failed to fetch MSISDN: ' + error);
});Sets development mode for iOS, which will use Development Sandbox for push messages in that case.
- enableDevelopment:
boolean, (required)
window.hybridmessaging.setDevelopment(true);Possible values are:
DeviceRegistrationStatus.UNVERIFIED,
DeviceRegistrationStatus.WAITING_FOR_PIN,
DeviceRegistrationStatus.LAST_PIN_VERIFICATION_FAILED,
DeviceRegistrationStatus.PIN_VERIFIED,
DeviceRegistrationStatus.INVALID,
DeviceRegistrationStatus.UNKNOWN- Initial version
- Modified Android part of plugin to no longer rely on a custom Application class to prevent conflicts with environments which define their own Application subclasses
- Restructured docs and extended method descriptions
- Fixed onPause and OnResume crashes on Android in case if lifecycle methods were called after hybrid messaging configuration but before service start
- Fixed foreground push behavior on Android after regression in 0.0.3
- Changed the requestVerificationVoiceCall method signature to not require MSISDN as input since it should be known to the SDK after initial verification request
- Fixed bug on iOS where startMessagingService was unresponsive in case if user denied receiving notifications at first push registration
- Changed the getMsisdnValue method behavior to return with failure in case if MSISDN was not available instead of returning with success and null value
- Fixed faulty argument type check for the setDevelopment function and corrected docs for setDevelopment and startMessagingService.
- Public release of the plugin.