In-app notifications and messaging

Use the D1 SDK to register the issuer application for in-app notifications. You can also retrieve a message list and mark messages as read.

Register the issuer application for notifications

D1 requires the issuer application to explicitly register with the messaging service to receive in-app notifications.

You perform this registration using the D1 SDK.

Flow

D1 delivers in-app notifications using push notifications.

Register and unregister

After calling D1Task.updatePushToken, register for message notifications by calling MessagingService.registerMessageNotification.

To stop receiving message notifications, call MessagingService.unregisterMessageNotification.

When using Click to Pay and the messaging service, call D1Task.login() first. Then call D1Task.updatePushToken(). Only then call MessagingService.registerMessageNotification().

Integration flow

Prerequisites :

SDK is properly initialised.
Issuer App called D1 SDK login API.
Issuer App updated the push token.

MessagingService messagingService = d1Task.getMessagingService();
messagingService.registerMessageNotification(new D1Task.Callback<Void>() {
    @Override
    public void onSuccess(Void data){
        // Proceed with the subsequent flows, for example, update UI.
    }
    @Override
    public void onError(@NonNull D1Exception exception){
        // Refer to D1 SDK Integration – Error Management section. 
    }
});

MessagingService messagingService = d1Task.getMessagingService();
messagingService.unregisterMessageNotification(new D1Task.Callback<Void>(){
    @Override
    public void onSuccess(Void unused){
        // Proceed with subsequent flows.
    }
    @Override
    public void onError(@NonNull D1Exception e){
        // Refer to D1 SDK Integration – Error Management section.
    }
});

do {
    messagingService = try d1Task.messagingService()
} catch let error {
    // possible error: D1Error.Code.deviceEnvironmentUnsafe
}

messagingService.registerMessageNotification { error in
    if error == nil {
        // Proceed with subsequent flows.
    } else {
        // Refer to D1 SDK Integration – Error Management section.
    }
}

messagingService.unregisterMessageNotification { error in
    if error == nil {
        // Proceed with subsequent flows.
    } else {
        // Refer to D1 SDK Integration – Error Management section.
    }
}

Retrieve messages and mark them as read

Flow

Integration flow

Prerequisites :

SDK is properly initialised
Issuer App called D1 SDK login API

You can handle messages from push notifications. You can also retrieve a message list by calling MessagingService.getMessageList.

MessagingService messagingService = d1Task.getMessagingService();
D1Task.Callback<List<Message>> callback = new D1Task.Callback<List<Message>>() {
    @Override
    public void onSuccess(List<Message> messages) {
        // Proceed with subsequent flows. For example, show the list to the end user.
        for(Message message : messages) {
            String id = message.getMessageID();
            String title = message.getTitle();
            String content = message.getMessage();
            boolean isRead = message.isRead();
            String timeStamp = message.getTimeStamp();
        }
    }
    @Override
    public void onError(@NonNull D1Exception e) {
        // Refer to D1 SDK Integration – Error Management section.
    }
};
messagingService.getMessageList(callback);

do {
    messagingService = try d1Task.messagingService()
} catch let error {
    // possible error: D1Error.Code.deviceEnvironmentUnsafe
}

messagingService.messageList { messageList, error in
    if let messageList = messageList {
        // Proceed with subsequent flows. For example, show the list to the end user.
        for message in messageList {
            let id = message.id // To be used for marking message as read.
            let title = message.title
            let content = message.message
            let isRead = message.isRead
            let timestamp = message.timestamp
        }
    } else if let error = error {
        // Refer to D1 SDK Integration – Error Management section.
    }
}

After the end user views the messages, mark them as read by calling MessagingService.markMessageListAsRead.

ArrayList<String> messageIDs = new ArrayList<>();
messageIDs.add("<#T##messageID1: String#>");
messageIDs.add("<#T##messageID2: String#>");

MessagingService messagingService = d1Task.getMessagingService();
D1Task.Callback<Void> callback = new D1Task.Callback<Void>() {
    @Override
    public void onSuccess(Void unused) {
        // Proceed with subsequent flows. For example, update UI.
    }
    @Override
    public void onError(@NonNull D1Exception e) {
        // Refer to D1 SDK Integration – Error Management section.
    }
};
messagingService.markMessageListAsRead(messageIDs, callback);

do {
    messagingService = try d1Task.messagingService()
} catch let error {
    // possible error: D1Error.Code.deviceEnvironmentUnsafe
}

let ids = ["<#T##messageID1: String#>", "<#T##messageID2: String#>"]
messagingService.markMessageListAsRead(ids) { error in
    if error == nil {
        // Proceed with subsequent flows. For example, update UI.
    } else {
        // Refer to D1 SDK Integration – Error Management section.
    }
}

PreviousIntegrate D1 notifications NextIntegrate Batch files

Was this helpful?