Invoking a Messaging Service

The following are the methods you can use for a messaging service.

Registering and Getting Messages from Quantum Fabric Messaging

To register, use the following code snippet to call the method. To send a message to the registered device, go to Quantum Fabric portal and send the message. You will receive a push notification message.

In the - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *), launchOptions method registers for remote notification and calls the KNYClient Intialize method. For more details, refer Initializing the Quantum Fabric Client SDK

In the - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *) deviceToken method, call the following code to register and receive push notifications.

 KNYMessagingService * messaging = [KNYMessagingService sharedMessagingService];

//
// Register with Messaging Service:
//

// the device token received in app delegate method
// - (void)application:(UIApplication *)application 
didRegisterForRemoteNotificationsWithDeviceToken: (NSData * ) deviceToken
NSData * deviceToken;

[messaging registerInBackgroundWithDeviceToken: deviceToken
    alias: @"<alias>"
    completion: ^ (BOOL succeeded, NSError * error) {    
        if (succeeded) {         // ...
               } else {       // handle the failure case
                   // use the details in 'error'
        }
    }
];

NOTE: Call these methods only after successful completion of -[KNYClient initializeInBackgroundWithAppKey:appSecret:serviceURLString:completion]. For more details, refer to Init method.

Unregistering from Messaging Service

This API stops receiving messages.

 [messaging unregisterInBackgroundUsingCompletionBlock: ^ (BOOL succeeded, NSError * error) {
    if (succeeded) {
        // ...
    } else {
        // handle the failure case
        // use the details in 'error'
    }
}];

Updating GeoLocation

 
[messaging updateGeoLocationInBackgroundWithLatitude: 28.449595 // note: appropriate value must be used
    longitude: -81.481600 // note: appropriate value must be used
    locationName: @"Sand Lake Rd, Orlando, FL 32819" // note: appropriate value must be used
    completion: ^ (BOOL succeeded, NSError * error) {
        if (succeeded) {
            // ...
        } else {
            // handle the failure case
            // use the details in 'error'
        }
    }
];

Fetching All messages in the Message Queue

 
[messaging fetchAllMessagesInBackgroundWithStartIndex: 0 // note: appropriate value must be used
    pageSize: 10 // note: appropriate value must be used
    completion: ^ (NSDictionary * objects, NSError * error) {
        if (error == nil) {
            // use data in 'objects' returned by the operation
            // ...
        } else {
            // handle the failure case
            // use the details in 'error'
        }
    }
];

Fetching a complete message for long messages using message ID

 [messaging fetchMessageContentInBackgroundWithMessageId: @"<message-id>"
    completion: ^ (NSString * string, NSError * error) {
        if (error == nil) {
            // use message in 'string' returned by the operation
            // ...
        } else {
            // handle the failure case
            // use the details in 'error'
        }
    }
];

Mark a message as read

 
[messaging markMessageReadInBackgroundWithMessageId: @"<message-id>"
    completion: ^ (BOOL succeeded, NSError * error) {
        if (succeeded) {
            // ...
        } else {
            // handle the failure case
            // use the details in 'error'
        }
    }
];