getTotalUnreadMsgCount

Description

info

Get the total number of unread messages across all conversations.

iOS

Function Prototype

  Future<dynamic> getTotalUnreadMsgCount({
    String? operationID,
  })

Input Parameters

None

Return Result

Name	Type	Description
~	dynamic	Success return

Code Example

    final count = await OpenIM.iMManager.conversationManager.getTotalUnreadMsgCount();
    //todo

Android

Function Prototype

- (void)getTotalUnreadMsgCountWithOnSuccess:(nullable OIMNumberCallback)onSuccess
                                  onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

None

Return Result

Name	Type	Description
onSuccess	OIMNumberCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

[OIMManager.manager getTotalUnreadMsgCountWithOnSuccess:^(NSInteger number) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

Function Prototype

   public void getTotalUnreadMsgCount(OnBase<String> base)

Input Parameters

Parameter Name	Parameter Type	Required	Description
base	OnBase<String>	Yes	Callback interface

Code Example

    OpenIMClient.getInstance().conversationManager.getTotalUnreadMsgCount(new OnBase<String>() {
              @Override
              public void onError(int code, String error) {

              }

              @Override
              public void onSuccess(String data) {

              }
          });

uni-app

Function Prototype

IMSDK.getTotalUnreadMsgCount(operationID?: string): Promise<WsResponse<number>>

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<number>>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();

// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();

// use in mini program
// import { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.getTotalUnreadMsgCount()
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('getTotalUnreadMsgCount', operationID: string): Promise<number>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<number>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getTotalUnreadMsgCount', IMSDK.uuid())
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.getTotalUnreadMsgCount(operationID?: string): Promise<number>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<number>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.getTotalUnreadMsgCount()
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static void GetTotalUnreadMsgCount(OnBase<int> cb)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback interface

Code Example

IMSDK.GetTotalUnreadMsgCount((count,err,errMsg)=>{

});