Set conversation extended data

Introduction

The conversation extended data (extendedData) is a JSON string customized and maintained by the business side. It can be attached to a conversation to store custom business data of the conversation.

Starting from version 3.3.0, ZIM supports setting extended data for conversations. Once set, the extended data is returned through the extendedData field of ZIMConversation when querying the conversation list or receiving a conversation changed notification.

Procedures

Call the setConversationExtendedData interface and pass in a list of ZIMConversationExtendedData (containing the conversation ID, conversation type, and extended data) to set the extended data of multiple conversations in batches. Pass an empty string as extendedData to delete the extended data of the corresponding conversation.

Notes:

• Only one-on-one and group chat conversations are supported. For other conversation types (such as rooms), the setting fails locally.
• Even if errorInfo.code in the callback indicates success, you should still check failedConversationInfos; the entries rejected locally are returned in this list.

// Build the conversation extended data list
ArrayList<ZIMConversationExtendedData> extendedDataList = new ArrayList<>();
ZIMConversationExtendedData data = new ZIMConversationExtendedData();
data.setConversationID("convId");
data.setConversationType(ZIMConversationType.PEER);
data.setExtendedData("{\"key\":\"value\"}");
extendedDataList.add(data);

// Set the conversation extended data
zim.setConversationExtendedData(extendedDataList, new ZIMConversationExtendedDataSetCallback() {
    @Override
    public void onConversationExtendedDataSet(ArrayList<ZIMConversationBaseInfo> failedConversationInfos, ZIMError errorInfo) {
        // Callback for the result of setting the conversation extended data
        // failedConversationInfos is the list of base information of the conversations that failed to be set
    }
});

// Build the conversation extended data list
ArrayList<ZIMConversationExtendedData> extendedDataList = new ArrayList<>();
ZIMConversationExtendedData data = new ZIMConversationExtendedData();
data.setConversationID("convId");
data.setConversationType(ZIMConversationType.PEER);
data.setExtendedData("{\"key\":\"value\"}");
extendedDataList.add(data);

// Set the conversation extended data
zim.setConversationExtendedData(extendedDataList, new ZIMConversationExtendedDataSetCallback() {
    @Override
    public void onConversationExtendedDataSet(ArrayList<ZIMConversationBaseInfo> failedConversationInfos, ZIMError errorInfo) {
        // Callback for the result of setting the conversation extended data
        // failedConversationInfos is the list of base information of the conversations that failed to be set
    }
});

// Build the conversation extended data list
ZIMConversationExtendedData *data = [[ZIMConversationExtendedData alloc] init];
data.conversationID = @"convId";
data.conversationType = ZIMConversationTypePeer;
data.extendedData = @"{\"key\":\"value\"}";

// Set the conversation extended data
[[ZIM getInstance] setConversationExtendedData:@[data] callback:^(NSArray<ZIMConversationBaseInfo *> * _Nonnull failedConversationInfos, ZIMError * _Nonnull errorInfo) {
        // Callback for the result of setting the conversation extended data
        if (errorInfo.code == ZIMErrorCodeSuccess) {
            // Set successfully. Note that you need to check the conversations that failed to be set in failedConversationInfos
        } else {
            // You can print the error code and error message to troubleshoot the error cause, referring to the ZIM official website error code documentation
        }
}];

// Build the conversation extended data list
ZIMConversationExtendedData *data = [[ZIMConversationExtendedData alloc] init];
data.conversationID = @"convId";
data.conversationType = ZIMConversationTypePeer;
data.extendedData = @"{\"key\":\"value\"}";

// Set the conversation extended data
[[ZIM getInstance] setConversationExtendedData:@[data] callback:^(NSArray<ZIMConversationBaseInfo *> * _Nonnull failedConversationInfos, ZIMError * _Nonnull errorInfo) {
        // Callback for the result of setting the conversation extended data
        if (errorInfo.code == ZIMErrorCodeSuccess) {
            // Set successfully. Note that you need to check the conversations that failed to be set in failedConversationInfos
        } else {
            // You can print the error code and error message to troubleshoot the error cause, referring to the ZIM official website error code documentation
        }
}];

// Build the conversation extended data list
const extendedDataList: ZIMConversationExtendedData[] = [
    { conversationID: 'xxx', conversationType: 0, extendedData: '{"key":"value"}' }
];

// Set the conversation extended data
zim.setConversationExtendedData(extendedDataList)
    .then((res: ZIMConversationExtendedDataSetResult) => {
        // Set successfully. Note that you need to check the conversations that failed to be set in res.failedConversationInfos
    })
    .catch((err: ZIMError) => {
        // Failed to set
    });

// Build the conversation extended data list
const extendedDataList: ZIMConversationExtendedData[] = [
    { conversationID: 'xxx', conversationType: 0, extendedData: '{"key":"value"}' }
];

// Set the conversation extended data
zim.setConversationExtendedData(extendedDataList)
    .then((res: ZIMConversationExtendedDataSetResult) => {
        // Set successfully. Note that you need to check the conversations that failed to be set in res.failedConversationInfos
    })
    .catch((err: ZIMError) => {
        // Failed to set
    });

// Build the conversation extended data list
std::vector<zim::ZIMConversationExtendedData> extendedDataList;
zim::ZIMConversationExtendedData data;
data.conversationID = "conv_id";
data.conversationType = zim::ZIMConversationType::ZIM_CONVERSATION_TYPE_PEER;
data.extendedData = "{\"key\":\"value\"}";
extendedDataList.push_back(data);

// Set the conversation extended data
zim_->setConversationExtendedData(
    extendedDataList,
    [=](const std::vector<zim::ZIMConversationBaseInfo> &failedConversationInfos,
        const zim::ZIMError &errorInfo) {
        // Callback for the result of setting the conversation extended data
        if (errorInfo.code == zim::ZIMErrorCode::ZIM_ERROR_CODE_SUCCESS) {
            // Set successfully. Note that you need to check the conversations that failed to be set in failedConversationInfos
        } else {
            // You can print the error code and error message to troubleshoot the error cause, referring to the ZIM official website error code documentation
        }
    });

// Build the conversation extended data list
std::vector<zim::ZIMConversationExtendedData> extendedDataList;
zim::ZIMConversationExtendedData data;
data.conversationID = "conv_id";
data.conversationType = zim::ZIMConversationType::ZIM_CONVERSATION_TYPE_PEER;
data.extendedData = "{\"key\":\"value\"}";
extendedDataList.push_back(data);

// Set the conversation extended data
zim_->setConversationExtendedData(
    extendedDataList,
    [=](const std::vector<zim::ZIMConversationBaseInfo> &failedConversationInfos,
        const zim::ZIMError &errorInfo) {
        // Callback for the result of setting the conversation extended data
        if (errorInfo.code == zim::ZIMErrorCode::ZIM_ERROR_CODE_SUCCESS) {
            // Set successfully. Note that you need to check the conversations that failed to be set in failedConversationInfos
        } else {
            // You can print the error code and error message to troubleshoot the error cause, referring to the ZIM official website error code documentation
        }
    });

// Build the conversation extended data list
ZIMConversationExtendedData data = ZIMConversationExtendedData();
data.conversationID = "convId";
data.conversationType = ZIMConversationType.peer;
data.extendedData = '{"key":"value"}';

// Set the conversation extended data
ZIM.getInstance().setConversationExtendedData([data]).then((value){
    // Set successfully. Note that you need to check the conversations that failed to be set in value.failedConversationInfos
}).catchError((onError){
    // You can print the error code and error message to troubleshoot the error cause, referring to the ZIM official website error code documentation
});

// Build the conversation extended data list
ZIMConversationExtendedData data = ZIMConversationExtendedData();
data.conversationID = "convId";
data.conversationType = ZIMConversationType.peer;
data.extendedData = '{"key":"value"}';

// Set the conversation extended data
ZIM.getInstance().setConversationExtendedData([data]).then((value){
    // Set successfully. Note that you need to check the conversations that failed to be set in value.failedConversationInfos
}).catchError((onError){
    // You can print the error code and error message to troubleshoot the error cause, referring to the ZIM official website error code documentation
});