Implementing Offline Push Notifications with the ZIM SDK

ZIM supports using offline push notifications when sending one-on-one messages, group messages, or initiating call invitations.

Implementation Process

Scenario 1: Using offline push when sending "one-on-one" or "group" messages

1. First, use the ZIMPushConfig object to configure offline push title, content, and other custom attributes.

2. Then, set the pushConfig parameter of ZIMMessageSendConfig to include your offline push configuration.

3. The sender calls sendMessage, passing in "sentConfig", to send a one-on-one or group message.

4. If the recipient or any group member is offline, they will receive the offline message once they come online.

ZIMTextMessage textMessage = new ZIMTextMessage();
ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMMessageSendConfig sentConfig = new ZIMMessageSendConfig();
sentConfig.pushConfig = pushConfig;

zim.sendMessage(textMessage, "myUserID", ZIMConversationType.PEER, sentConfig, new ZIMMessageSentCallback() {
        @Override
        public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {

        }

        @Override
        public void onMessageAttached(ZIMMessage message) {

        }
});

ZIMTextMessage textMessage = new ZIMTextMessage();
ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMMessageSendConfig sentConfig = new ZIMMessageSendConfig();
sentConfig.pushConfig = pushConfig;

zim.sendMessage(textMessage, "myUserID", ZIMConversationType.PEER, sentConfig, new ZIMMessageSentCallback() {
        @Override
        public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {

        }

        @Override
        public void onMessageAttached(ZIMMessage message) {

        }
});

ZIMPushConfig *pushConfig = [ZIMPushConfig alloc] init];
pushConfig.title = @"Offline push title";
pushConfig.content = @"Offline push content";
pushConfig.payload = @"Custom payload, optional";
pushConfig.resourcesID = @"Resource ID, optional";

ZIMMessageSendConfig *sendConfig = [ZIMMessageSendConfig alloc] init];
sendConfig.pushConfig = pushConfig;

[zim sendMessage:zimMessage toConversationID:conversationID conversationType:ZIMConversationTypePeer config:sendConfig callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {

}];

ZIMPushConfig *pushConfig = [ZIMPushConfig alloc] init];
pushConfig.title = @"Offline push title";
pushConfig.content = @"Offline push content";
pushConfig.payload = @"Custom payload, optional";
pushConfig.resourcesID = @"Resource ID, optional";

ZIMMessageSendConfig *sendConfig = [ZIMMessageSendConfig alloc] init];
sendConfig.pushConfig = pushConfig;

[zim sendMessage:zimMessage toConversationID:conversationID conversationType:ZIMConversationTypePeer config:sendConfig callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {

}];

zim::ZIMPushConfig pushConfig;
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

zim::ZIMMessageSendConfig sendConfig;
sendConfig.pushConfig = pushConfig;

zim::ZIMMessage* message = nullptr;
zim::ZIMTextMessage text_message;
text_message.message = "message";
message = &text_message;

zim::ZIMConversationType type = zim::ZIMConversationType::ZIM_CONVERSATION_TYPE_PEER;
auto notification = std::make_shared<zim::ZIMMessageSendNotification>(
            [=](const std::shared_ptr<zim::ZIMMessage> &message) { int i = 0; });
// For single chat, toConversationID is the target user's userID; for group chat, it's the groupID.
zim_->sendMessage(message, "toConversationID", type, sendConfig, notification,
                    [=](const std::shared_ptr<zim::ZIMMessage> &message,
                              const zim::ZIMError &errorInfo) { int i = 0; });

zim::ZIMPushConfig pushConfig;
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

zim::ZIMMessageSendConfig sendConfig;
sendConfig.pushConfig = pushConfig;

zim::ZIMMessage* message = nullptr;
zim::ZIMTextMessage text_message;
text_message.message = "message";
message = &text_message;

zim::ZIMConversationType type = zim::ZIMConversationType::ZIM_CONVERSATION_TYPE_PEER;
auto notification = std::make_shared<zim::ZIMMessageSendNotification>(
            [=](const std::shared_ptr<zim::ZIMMessage> &message) { int i = 0; });
// For single chat, toConversationID is the target user's userID; for group chat, it's the groupID.
zim_->sendMessage(message, "toConversationID", type, sendConfig, notification,
                    [=](const std::shared_ptr<zim::ZIMMessage> &message,
                              const zim::ZIMError &errorInfo) { int i = 0; });

ZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMMessageSendConfig sendConfig = ZIMMessageSendConfig();
sendConfig.pushConfig = pushConfig;

ZIM.getInstance()!.sendMessage(ZIMTextMessage(message: 'message'), 'toUserID', ZIMConversationType.peer, sendConfig)
.then((value) => {})
.onError((error, stackTrace) => {});

ZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMMessageSendConfig sendConfig = ZIMMessageSendConfig();
sendConfig.pushConfig = pushConfig;

ZIM.getInstance()!.sendMessage(ZIMTextMessage(message: 'message'), 'toUserID', ZIMConversationType.peer, sendConfig)
.then((value) => {})
.onError((error, stackTrace) => {});

const pushConfig: ZIMPushConfig = {
    title: "Offline push title",
    content: "Offline push content",
    payload: "Custom payload, optional", 
    resourcesID: "Resource ID, optional",
}

const sendConfig: ZIMMessageSendConfig = {
    priority: 2,
    pushConfig: pushConfig
};

const toUserID = '';
const messageTextObj: ZIMMessage = { type: 1, message: 'Message content' };
zim.sendMessage(messageTextObj, toUserID, 0, sendConfig)
    .then((res: ZIMMessageSentResult) => {
        // Success
    })
    .catch((err: ZIMError) => {
        // Failed
    });

const pushConfig: ZIMPushConfig = {
    title: "Offline push title",
    content: "Offline push content",
    payload: "Custom payload, optional", 
    resourcesID: "Resource ID, optional",
}

const sendConfig: ZIMMessageSendConfig = {
    priority: 2,
    pushConfig: pushConfig
};

const toUserID = '';
const messageTextObj: ZIMMessage = { type: 1, message: 'Message content' };
zim.sendMessage(messageTextObj, toUserID, 0, sendConfig)
    .then((res: ZIMMessageSentResult) => {
        // Success
    })
    .catch((err: ZIMError) => {
        // Failed
    });

Scenario 2: Using offline push when sending call invitations

1. Use the ZIMPushConfig object to configure offline push title, content, and other custom attributes.

2. Add the push config to the pushConfig property of the ZIMCallInviteConfig object.

3. The sender calls callInvite, passing in "callInviteConfig", to send an invitation.

4. Invited users who are offline will receive the corresponding offline push notification. When coming back online, if the call invitation has not ended yet, they will receive the callback of onCallInvitationReceived.

ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMCallInviteConfig callInviteConfig = new ZIMCallInviteConfig();
callInviteConfig.pushConfig = pushConfig;

ArrayList<String> invitees = new ArrayList<>();
invitees.add("userA");
invitees.add("userB");
zim.callInvite(invitees, callInviteConfig, new ZIMCallInvitationSentCallback() {
    @Override
    public void onCallInvitationSent(String callID, ZIMCallInvitationSentInfo info, ZIMError errorInfo) {
    }
});

ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMCallInviteConfig callInviteConfig = new ZIMCallInviteConfig();
callInviteConfig.pushConfig = pushConfig;

ArrayList<String> invitees = new ArrayList<>();
invitees.add("userA");
invitees.add("userB");
zim.callInvite(invitees, callInviteConfig, new ZIMCallInvitationSentCallback() {
    @Override
    public void onCallInvitationSent(String callID, ZIMCallInvitationSentInfo info, ZIMError errorInfo) {
    }
});

ZIMPushConfig *pushConfig = [ZIMPushConfig alloc] init];
pushConfig.title = @"Offline push title";
pushConfig.content = @"Offline push content";
pushConfig.payload = @"Custom payload, optional";
pushConfig.resourcesID = @"Resource ID, optional";

ZIMCallInviteConfig *callInviteConfig = [ZIMMessageSendConfig alloc] init];
callInviteConfig.pushConfig = pushConfig;

[[ZIM getInstance] callInviteWithInvitees:@[@"userA",@"userB"] config: callInviteConfig callback:^(NSString * _Nonnull callID, ZIMCallInvitationSentInfo * _Nonnull info, ZIMError * _Nonnull errorInfo) {    
}];

ZIMPushConfig *pushConfig = [ZIMPushConfig alloc] init];
pushConfig.title = @"Offline push title";
pushConfig.content = @"Offline push content";
pushConfig.payload = @"Custom payload, optional";
pushConfig.resourcesID = @"Resource ID, optional";

ZIMCallInviteConfig *callInviteConfig = [ZIMMessageSendConfig alloc] init];
callInviteConfig.pushConfig = pushConfig;

[[ZIM getInstance] callInviteWithInvitees:@[@"userA",@"userB"] config: callInviteConfig callback:^(NSString * _Nonnull callID, ZIMCallInvitationSentInfo * _Nonnull info, ZIMError * _Nonnull errorInfo) {    
}];

zim::ZIMPushConfig pushConfig;
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

zim::ZIMCallInviteConfig callInviteConfig;
callInviteConfig.pushConfig = pushConfig;

zim_->callInvite(invitees, callInviteConfig, [=](std::string callID, zim::ZIMCallInvitationSentInfo info, zim::ZIMError errorInfo) {}); 

zim::ZIMPushConfig pushConfig;
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

zim::ZIMCallInviteConfig callInviteConfig;
callInviteConfig.pushConfig = pushConfig;

zim_->callInvite(invitees, callInviteConfig, [=](std::string callID, zim::ZIMCallInvitationSentInfo info, zim::ZIMError errorInfo) {}); 

ZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMCallInviteConfig callInviteConfig = ZIMCallInviteConfig();
callInviteConfig.pushConfig = pushConfig;

ZIM.getInstance()!.callInvite(["userA","userB"], callInviteConfig)
.then((value) {})
.catchError((onError){});

ZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.payload = "Custom payload, optional";
pushConfig.resourcesID = "Resource ID, optional";

ZIMCallInviteConfig callInviteConfig = ZIMCallInviteConfig();
callInviteConfig.pushConfig = pushConfig;

ZIM.getInstance()!.callInvite(["userA","userB"], callInviteConfig)
.then((value) {})
.catchError((onError){});

const pushConfig: ZIMPushConfig = {
    title: "Offline push title",
    content: "Offline push content",
    payload: "Custom payload, optional",
    resourcesID: "Resource ID, optional",
}

const callInviteConfig: ZIMCallInviteConfig = {
    mode: 0,
    timeout: 90,
    extendedData: '',
    pushConfig: pushConfig
}

const invitees = ['xxxx'];  // List of invited user IDs
zim.callInvite(invitees, callInviteConfig)
    .then((res: ZIMCallInvitationSentResult) => {
        const callID = res.callID;
        // Success
        // The callID is a unique ID assigned by the SDK for the call invitation. This callID will be used in subsequent events.
    })
    .catch((err: ZIMError) => {
        // Failed
    })

const pushConfig: ZIMPushConfig = {
    title: "Offline push title",
    content: "Offline push content",
    payload: "Custom payload, optional",
    resourcesID: "Resource ID, optional",
}

const callInviteConfig: ZIMCallInviteConfig = {
    mode: 0,
    timeout: 90,
    extendedData: '',
    pushConfig: pushConfig
}

const invitees = ['xxxx'];  // List of invited user IDs
zim.callInvite(invitees, callInviteConfig)
    .then((res: ZIMCallInvitationSentResult) => {
        const callID = res.callID;
        // Success
        // The callID is a unique ID assigned by the SDK for the call invitation. This callID will be used in subsequent events.
    })
    .catch((err: ZIMError) => {
        // Failed
    })

Scenario 3: iOS Notification Grouping

To achieve notification grouping for iOS offline push, set the threadID property of ZIMPushConfig on the sending side.

ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.threadID = "Group identifier";

ZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.threadID = "Group identifier";

ZIMPushConfig *pushConfig = [ZIMPushConfig alloc] init];
pushConfig.title = @"Offline push title";
pushConfig.content = @"Offline push content";
pushConfig.threadID = @"Group identifier";

ZIMPushConfig *pushConfig = [ZIMPushConfig alloc] init];
pushConfig.title = @"Offline push title";
pushConfig.content = @"Offline push content";
pushConfig.threadID = @"Group identifier";

zim::ZIMPushConfig pushConfig;
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.threadID = "Group identifier";

zim::ZIMPushConfig pushConfig;
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.threadID = "Group identifier";

ZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.threadID = "Group identifier";

ZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.title = "Offline push title";
pushConfig.content = "Offline push content";
pushConfig.threadID = "Group identifier";

const pushConfig: ZIMPushConfig = {
    title: "Offline push title",
    content: "Offline push content",
    threadID: "Group identifier",
}

const pushConfig: ZIMPushConfig = {
    title: "Offline push title",
    content: "Offline push content",
    threadID: "Group identifier",
}

Scenario 4: iOS Badge Count

You can update the notification badge count by calling updateUserBadge.

A common scenario: When logged in on multiple devices, if one device clears the unread count for a conversation, the badge on the iOS app should also be decreased accordingly. For example, if the badge count was 10, and you cleared 8 unread messages in one conversation, call this interface to set the badge count to 2.

zim.updateUserBadge(2, new ZIMUserBadgeUpdatedCallback() {
    @Override
    public void onUserBadgeUpdated(ZIMError errorInfo) {
    }
});

zim.updateUserBadge(2, new ZIMUserBadgeUpdatedCallback() {
    @Override
    public void onUserBadgeUpdated(ZIMError errorInfo) {
    }
});

[[ZIM getInstance] updateUserBadge:2 callback:^(ZIMError * _Nonnull errorInfo) {
    
}];

[[ZIM getInstance] updateUserBadge:2 callback:^(ZIMError * _Nonnull errorInfo) {
    
}];

zim_->updateUserBadge(2, [=](zim::ZIMError errorInfo) {}); 

zim_->updateUserBadge(2, [=](zim::ZIMError errorInfo) {}); 

ZIM.getInstance()!.updateUserBadge(2).then(() {

}).catchError((onError){

});

ZIM.getInstance()!.updateUserBadge(2).then(() {

}).catchError((onError){

});

zim.updateUserBadge(2)
    .then(() => {
        // Success
    })
    .catch((err: ZIMError) => {
        // Failed
    });

zim.updateUserBadge(2)
    .then(() => {
        // Success
    })
    .catch((err: ZIMError) => {
        // Failed
    });