Export and import messages

Overview

With the ZIM SDK, you can export the local chat history (one-to-one messages and group messages) of the current user's client as a backup. This backup can be used to migrate chat history when changing devices or to restore deleted messages.

Export messages

After creating a ZIM object and logging in, you can call the exportLocalMessagesToFolderPath interface by providing an absolute path to save the chat messages of the current user to that directory.

The progress of the export will be returned through the ZIMMessageExportingProgress callback interface.

The result of the export operation will be returned through the ZIMMessageExportedCallback callback interface.

Note

The exported message file name for this interface is zim_backup_msg_text. If the same path is provided in multiple calls to this interface, the ZIM SDK will automatically rename the old zim_backup_msg_text file to ensure that the latest exported file retains the name zim_backup_msg_text.

Untitled

// Export messages
ZIMMessageExportConfig *config = [[ZIMMessageExportConfig alloc] init];
[self.zim exportLocalMessagesToFolderPath:@"folderPath" config: config 
                                 progress:^(unsigned long long exportedMessageCount,
                                            unsigned long long totalMessageCount) {
                                                // Export progress callback
                                } callback:^(ZIMError *errorInfo) {
                                                // Export progress callback
}];

Copied!

Import messages

After creating a ZIM object and logging in, you can call the importLocalMessagesToFolderPath interface by providing the absolute path of the directory where the backup file is located. This will import the messages.

By default, the ZIM SDK reads the file with the name "zim_backup_msg_text" in the specified directory. If there are multiple backups in that path, please ensure that the file you want to import is named "zim_backup_msg_text".

The progress of the import will be returned through the ZIMMessageImportingProgress callback interface.

The result of the import operation will be returned through the ZIMMessageImportedCallback interface.

Untitled

// Import messages
ZIMMessageImportConfig *config = [[ZIMMessageImportConfig alloc] init];
[self.zim importLocalMessagesToFolderPath:@"folderPath" config: config 
                                 progress:^(unsigned long long importedMessageCount,
                                            unsigned long long totalMessageCount) {
                                                //Import progress callback
                                } callback:^(ZIMError *errorInfo) {
                                                //Import result callback

Copied!