### Native SDK Example (iOS/Android) Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the OnGroupApplicationAccepted callback with native SDKs. ```APIDOC ## OnGroupApplicationAccepted ### Description When a group join application is accepted, the applicant and the group owner/administrators receive this callback. ### Return Prototype ```java void OnGroupApplicationAccepted(GroupApplicationInfo application); ``` ### Return Results | Name | Type | Description | |---|---|---| | application | GroupApplicationInfo | Group application info | ``` -------------------------------- ### Install OpenIM WASM Client SDK Source: https://docs.openim.io/sdks/quickstart/browser Install the SDK using npm or yarn. ```bash npm install @openim/wasm-client-sdk # or yarn add @openim/wasm-client-sdk ``` -------------------------------- ### Web/Mini Program SDK Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the Web, Mini Program SDK. ```APIDOC ## onGroupApplicationAccepted ### Description When a group join application is accepted, the applicant and the group owner/administrators receive this callback. ### Return Prototype ```javascript onGroupApplicationAccepted(data: WSEvent): void; ``` ### Return Results | Name | Type | Description | |---|---|---| | data | WSEvent | Group application info | ### Call Example ```javascript import { getSDK } from '@openim/client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnGroupApplicationAccepted, ({ data }) => { // data: group join application }); ``` ``` -------------------------------- ### Web SDK Call Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the Web SDK. This example demonstrates how to subscribe to the event and access the group join application data. ```javascript 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.on(CbEvents.OnGroupApplicationAccepted, ({ data }) => { // data: group join application }); ``` -------------------------------- ### Uni-app Polyfill SDK Call Example Source: https://docs.openim.io/sdks/callback/onRecvNewMessage Example of subscribing to the OnRecvNewMessage event using the openim-uniapp-polyfill SDK. This setup is for uni-app platforms. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnRecvNewMessage, ({ data }) => { // data: new message }); ``` -------------------------------- ### Objective-C SDK Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the Objective-C SDK. ```APIDOC ## onGroupApplicationAccepted ### Description When a group join application is accepted, the applicant and the group owner/administrators receive this callback. ### Return Prototype ```objc - (void)onGroupApplicationAccepted:(OIMGroupApplicationInfo *)groupApplication; ``` ### Return Results | Name | Type | Description | |---|---|---| | application | OIMGroupApplicationInfo | Group application info | ``` -------------------------------- ### JavaScript Call Example (uni-app) Source: https://docs.openim.io/sdks/callback/onConnectSuccess Example of subscribing to the OnConnectSuccess event using the openim-uniapp-polyfill library. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnConnectSuccess, () => {}); ``` -------------------------------- ### Browser/Electron/MiniProgram Call Example Source: https://docs.openim.io/sdks/callback/onProgress Example of how to register the onProgress callback using the OpenIM WASM SDK in a JavaScript environment. Includes commented-out examples for Electron and MiniProgram usage. ```javascript 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.on(CbEvents.OnProgress, ({ data }) => { // data: message send progress }); ``` -------------------------------- ### Uni-app Call Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the uni-app SDK. This example shows how to subscribe to the event and process the group join application data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationAccepted, ({ data }) => { // data: group join application }); ``` -------------------------------- ### uni-app SDK Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the uni-app SDK. ```APIDOC ## onGroupApplicationAccepted ### Description When a group join application is accepted, the applicant and the group owner/administrators receive this callback. ### Return Prototype ```javascript onGroupApplicationAccepted(data: WSEvent): void; ``` ### Return Results | Name | Type | Description | |---|---|---| | data | WSEvent | Group application info | ### Call Example ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationAccepted, ({ data }) => { // data: group join application }); ``` ``` -------------------------------- ### JavaScript SDK Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the JavaScript SDK. ```APIDOC ## onGroupApplicationAccepted ### Description When a group join application is accepted, the applicant and the group owner/administrators receive this callback. ### Return Prototype ```javascript Function(GroupApplicationInfo info)? onGroupApplicationAccepted; ``` ### Return Results | Name | Type | Description | |---|---|---| | info | GroupApplicationInfo | Group application info | ### Call Example ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnGroupApplicationAccepted, ({ data }) => { // data: group join application }); ``` ``` -------------------------------- ### JavaScript Call Example (uni-app) Source: https://docs.openim.io/sdks/callback/onBlackAdded This example shows how to subscribe to the OnBlackAdded event in a uni-app environment using the provided polyfill. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnBlackAdded, ({ data }) => { // data: blacklist info }); ``` -------------------------------- ### Call Example for onConnecting in uni-app Source: https://docs.openim.io/sdks/callback/onConnecting Example of how to subscribe to the OnConnecting event using the openim-uniapp-polyfill library. This is used for uni-app development. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnConnecting, () => {}); ``` -------------------------------- ### JavaScript Call Example (uni-app) Source: https://docs.openim.io/sdks/callback/onBlackDeleted Example of how to subscribe to the OnBlackDeleted event using the openim-uniapp-polyfill library. This is for uni-app development. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnBlackDeleted, ({ data }) => { // data: blacklist info }); ``` -------------------------------- ### JavaScript SDK Example Source: https://docs.openim.io/sdks/callback/onRecvOfflineNewMessage Example of how to subscribe to the OnRecvOfflineNewMessage event using the JavaScript SDK. ```APIDOC ## Subscribe to OnRecvOfflineNewMessage ### Description Listens for new offline messages when the application is in the background. ### Method `IMSDK.on(CbEvents.OnRecvOfflineNewMessage, callback)` ### Parameters - **event** (string) - The event name, `CbEvents.OnRecvOfflineNewMessage`. - **callback** (function) - A function that receives an object containing the new offline message data. ### Callback Data - **data** (object) - Contains the new offline message details. - **msg** (Message) - The new offline message object. ### Example ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnRecvOfflineNewMessage, ({ data }) => { console.log('New offline message received:', data.msg); }); ``` ``` -------------------------------- ### JavaScript Call Example (Browser/Electron/MiniProgram) Source: https://docs.openim.io/sdks/callback/onBlackAdded This example demonstrates how to use the onBlackAdded callback in a JavaScript environment, such as Electron or MiniProgram. Ensure the SDK is correctly initialized before subscribing. ```javascript 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.on(CbEvents.OnBlackAdded, ({ data }) => { // data: blacklist info }); ``` -------------------------------- ### Uni-app SDK Example Source: https://docs.openim.io/sdks/callback/onRecvOfflineNewMessage Example of how to subscribe to the OnRecvOfflineNewMessage event using the Uni-app SDK. ```APIDOC ## Subscribe to OnRecvOfflineNewMessage ### Description Listens for new offline messages when the application is in the background. ### Method `IMSDK.subscribe(IMSDK.IMEvents.OnRecvOfflineNewMessage, callback)` ### Parameters - **event** (string) - The event name, `IMSDK.IMEvents.OnRecvOfflineNewMessage`. - **callback** (function) - A function that receives an object containing the new offline message data. ### Callback Data - **data** (object) - Contains the new offline message details. - **msg** (Message) - The new offline message object. ### Example ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnRecvOfflineNewMessage, ({ data }) => { console.log('New offline message received:', data.msg); }); ``` ``` -------------------------------- ### Call Example (JavaScript/Web) Source: https://docs.openim.io/sdks/callback/onFriendApplicationAccepted Demonstrates how to register the onFriendApplicationAccepted event listener using the SDK in a JavaScript environment. This example shows usage with Electron, Mini Programs, and standard web clients. ```javascript 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.on(CbEvents.OnFriendApplicationAccepted, ({ data }) => { // data: friend application }); ``` -------------------------------- ### uni-app SDK Example Source: https://docs.openim.io/sdks/callback/onJoinedGroupAdded Example of how to use the onJoinedGroupAdded callback with the uni-app SDK. ```APIDOC ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnJoinedGroupAdded, ({ data }) => { // data: group info console.log('User joined a new group:', data); }); ``` ``` -------------------------------- ### JavaScript SDK Example Source: https://docs.openim.io/sdks/callback/onJoinedGroupAdded Example of how to use the onJoinedGroupAdded callback with the JavaScript SDK. ```APIDOC ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnJoinedGroupAdded, ({ data }) => { // data: group info console.log('User joined a new group:', data); }); ``` ``` -------------------------------- ### Call Example for onConnecting in Electron/MiniProgram Source: https://docs.openim.io/sdks/callback/onConnecting Example of how to use the onConnecting callback with the OpenIM SDK, suitable for Electron or MiniProgram environments. It subscribes to the OnConnecting event. ```javascript 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.on(CbEvents.OnConnecting, () => {}); ``` -------------------------------- ### Initialize and Login SDK in Electron Source: https://docs.openim.io/sdks/quickstart/electron Initialize the OpenIM SDK with Electron-specific configurations and log in the user. This example also shows how to set up event listeners for connection status. ```javascript import { CbEvents, LogLevel } from '@openim/wasm-client-sdk'; import type { WSEvent } from '@openim/wasm-client-sdk/lib/types/entity'; IMSDK.on(CbEvents.OnConnecting, handleConnecting); IMSDK.on(CbEvents.OnConnectFailed, handleConnectFailed); IMSDK.on(CbEvents.OnConnectSuccess, handleConnectSuccess); // Electron await IMSDK.initSDK({ platformID: 'your-platform-id', apiAddr: 'http://your-server-ip:10002', wsAddr: 'ws://your-server-ip:10001', dataDir: 'your-db-dir', logFilePath: 'your-log-file-path', logLevel: LogLevel.Debug, isLogStandardOutput: true, }); await IMSDK.login({ userID: 'your-user-id', token: 'your-token', }); // Web await IMSDK.login({ userID: 'your-user-id', token: 'your-token', platformID: 5, apiAddr: 'http://your-server-ip:10002', wsAddr: 'ws://your-server-ip:10001', logLevel: LogLevel.Debug, }); function handleConnecting() { // Connecting... } function handleConnectFailed({ errCode, errMsg }: WSEvent) { // Connection failed ❌ console.log(errCode, errMsg); } function handleConnectSuccess() { // Connection successful ✅ } ``` -------------------------------- ### Call Example for OnFriendAdded (uni-app) Source: https://docs.openim.io/sdks/callback/onFriendAdded Example of how to subscribe to the OnFriendAdded event using the openim-uniapp-polyfill library. This is specifically for uni-app development. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnFriendAdded, ({ data }) => { // data: friend info }); ``` -------------------------------- ### Dart SDK Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAccepted Example of how to use the onGroupApplicationAccepted callback with the Dart SDK (Flutter). ```APIDOC ## onGroupApplicationAccepted ### Description When a group join application is accepted, the applicant and the group owner/administrators receive this callback. ### Return Prototype ```dart void onGroupApplicationAccepted(GroupApplicationInfo info) ``` ### Return Results | Name | Type | Description | |---|---|---| | info | GroupApplicationInfo | Group application info | ``` -------------------------------- ### JavaScript Call Example (Electron/Mini Program) Source: https://docs.openim.io/sdks/callback/onConnectSuccess Example of using the onConnectSuccess callback with the OpenIM SDK in Electron or Mini Program environments. Ensure the correct SDK import based on your environment. ```javascript 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.on(CbEvents.OnConnectSuccess, () => {}); ``` -------------------------------- ### Failure Return Example Source: https://docs.openim.io/restapi/apis/authenticationManagement/getAdminToken This snippet illustrates a typical error response when the request to get an APP admin token fails. It includes an error code and a message. ```json { "errCode": 1004, "errMsg": "RecordNotFoundError", "errDlt": ": [1004]RecordNotFoundError" } ``` -------------------------------- ### Success Return Example Source: https://docs.openim.io/restapi/apis/authenticationManagement/getAdminToken This example demonstrates the structure of a successful response when obtaining an APP admin token. It contains the token and its expiration time. ```json { "errCode": 0, "errMsg": "", "errDlt": "", "data": { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiJvcGVuSU1BZG1pbiIsIlBsYXRmb3JtSUQiOjEsImV4cCI6MTY5Njc1NDgwNSwibmJmIjoxNjg4OTc4NTA1LCJpYXQiOjE2ODg5Nzg4MDV9.SAu86X3PzfYjtjBeYA4vZefNr1IiFKRgg12FeiXSm14", "expireTimeSeconds": 7776000 } } ``` -------------------------------- ### Uni-app Call Example Source: https://docs.openim.io/sdks/callback/onConnectFailed Example of how to subscribe to the OnConnectFailed event using the SDK in a Uni-app environment. This uses a polyfill for compatibility. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnConnectFailed, ({ errCode, errMsg }) => {}); ``` -------------------------------- ### Call Example (uni-app) Source: https://docs.openim.io/sdks/callback/onFriendApplicationAccepted Shows how to subscribe to the OnFriendApplicationAccepted event using the openim-uniapp-polyfill library. The callback receives an object containing the friend application data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnFriendApplicationAccepted, ({ data }) => { // data: friend application }); ``` -------------------------------- ### JavaScript/Browser/Electron/MiniProgram Call Example Source: https://docs.openim.io/sdks/callback/onGroupMemberDeleted Example of how to subscribe to the OnGroupMemberDeleted event using the SDK in a browser, Electron, or MiniProgram environment. ```javascript 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.on(CbEvents.OnGroupMemberDeleted, ({ data }) => { // data: group member info }); ``` -------------------------------- ### JavaScript Call Example (Web/Electron/MiniProgram) Source: https://docs.openim.io/sdks/callback/onBlackDeleted Example of how to use the onBlackDeleted callback in a JavaScript environment for web, Electron, or MiniProgram. It shows how to import the SDK and subscribe to the event. ```javascript 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.on(CbEvents.OnBlackDeleted, ({ data }) => { // data: blacklist info }); ``` -------------------------------- ### JavaScript Call Example (Web/Electron/MiniProgram) Source: https://docs.openim.io/sdks/callback/onGroupApplicationAdded Example of how to register the onGroupApplicationAdded callback using the IMSDK in a JavaScript environment. This is typically used in Electron, Mini Programs, or web applications. ```javascript 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.on(CbEvents.OnGroupApplicationAdded, ({ data }) => { // data: group join application }); ``` -------------------------------- ### Call Example for onSelfInfoUpdated in JavaScript SDK Source: https://docs.openim.io/sdks/callback/onSelfUserInfoUpdate This example demonstrates how to use the onSelfInfoUpdated callback with the JavaScript SDK. Ensure the SDK is imported and initialized before subscribing. ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnSelfInfoUpdated, ({ data }) => { // data: personal profile }); ``` -------------------------------- ### Call Example for onSelfInfoUpdated in uni-app Source: https://docs.openim.io/sdks/callback/onSelfUserInfoUpdate This example shows how to subscribe to the onSelfInfoUpdated event using the openim-uniapp-polyfill. The data parameter contains the updated user profile. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnSelfInfoUpdated, ({ data }) => { // data: personal profile }); ``` -------------------------------- ### Electron/Mini Program SDK Call Example Source: https://docs.openim.io/sdks/callback/onRecvNewMessage Example of how to use the onRecvNewMessage callback with the OpenIM SDK in Electron, Mini Programs, or Browser environments. Ensure the SDK is correctly imported and initialized. ```javascript 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.on(CbEvents.OnRecvNewMessage, ({ data }) => { // data: new message }); ``` -------------------------------- ### Call Example for onFriendAdded (JavaScript/Electron/MiniProgram) Source: https://docs.openim.io/sdks/callback/onFriendAdded Example of how to subscribe to the OnFriendAdded event using the OpenIM SDK in JavaScript. This is useful for Electron, Mini Programs, and browser environments. ```javascript 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.on(CbEvents.OnFriendAdded, ({ data }) => { // data: friend info }); ``` -------------------------------- ### JavaScript/uni-app Call Example Source: https://docs.openim.io/sdks/callback/onGroupMemberDeleted Example of how to subscribe to the OnGroupMemberDeleted event using the SDK in a uni-app environment. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupMemberDeleted, ({ data }) => { // data: group member info }); ``` -------------------------------- ### uni-app Polyfill SDK Call Example Source: https://docs.openim.io/sdks/callback/onGroupMemberAdded Example of how to subscribe to the OnGroupMemberAdded event using the openim-uniapp-polyfill SDK. This is specific to uni-app development. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupMemberAdded, ({ data }) => { // data: group member info }); ``` -------------------------------- ### Browser/Electron/MiniProgram Call Example Source: https://docs.openim.io/sdks/callback/onGroupInfoChanged Example of how to use the onGroupInfoChanged callback in a browser, Electron, or MiniProgram environment using the SDK. Ensure the correct SDK import based on your environment. ```javascript 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.on(CbEvents.OnGroupInfoChanged, ({ data }) => { // data: group info }); ``` -------------------------------- ### JavaScript Call Example (Electron/Browser/MiniProgram) Source: https://docs.openim.io/sdks/callback/onConnectFailed Example of how to subscribe to the OnConnectFailed event using the SDK in a JavaScript environment like Electron, Browser, or MiniProgram. Ensure the SDK is correctly imported for your environment. ```javascript 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.on(CbEvents.OnConnectFailed, ({ errCode, errMsg }) => {}); ``` -------------------------------- ### Call Example (Web/Electron/MiniProgram) Source: https://docs.openim.io/sdks/callback/onGroupApplicationRejected Demonstrates how to register the onGroupApplicationRejected callback using the IMSDK in a web, Electron, or MiniProgram environment. It logs the group join application data when the event is triggered. ```javascript 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.on(CbEvents.OnGroupApplicationRejected, ({ data }) => { // data: group join application }); ``` -------------------------------- ### Uni-app Call Example Source: https://docs.openim.io/sdks/callback/onProgress Example of how to subscribe to the OnProgress event using the OpenIM uni-app polyfill. This allows tracking message sending progress within a uni-app project. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnProgress, ({ data }) => { // data: message send progress }); ``` -------------------------------- ### Web SDK Call Example Source: https://docs.openim.io/sdks/callback/onSyncServerFailed Example of how to register the onSyncServerFailed callback using the Web SDK. This is used to handle server sync failures. ```typescript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnSyncServerFailed, () => {}); ``` -------------------------------- ### Call Example (uni-app) Source: https://docs.openim.io/sdks/callback/onGroupApplicationRejected Shows how to subscribe to the OnGroupApplicationRejected event using the IMSDK in a uni-app environment. The callback receives group application data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationRejected, ({ data }) => { // data: group join application }); ``` -------------------------------- ### uni-app onRecvNewMessages Example Source: https://docs.openim.io/sdks/callback/onRecvNewMessages This example shows how to subscribe to the OnRecvNewMessages event in a uni-app environment using the openim-uniapp-polyfill. It illustrates how to receive and process new message data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnRecvNewMessages, ({ data }) => { // data: new message list }); ``` -------------------------------- ### uni-app SDK Call Example Source: https://docs.openim.io/sdks/callback/onSyncServerFailed Example of how to subscribe to the OnSyncServerFailed event using the uni-app SDK. This is used to handle server sync failures. ```typescript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerFailed, () => {}); ``` -------------------------------- ### uni-app Call Example Source: https://docs.openim.io/sdks/callback/onJoinedGroupDeleted Example of how to use the onJoinedGroupDeleted callback in uni-app. It uses IMSDK to subscribe to the event. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnJoinedGroupDeleted, ({ data }) => { // data: group info }); ``` -------------------------------- ### Web SDK Call Example for onKickedOffline Source: https://docs.openim.io/sdks/callback/onKickedOffline Example of how to subscribe to the OnKickedOffline event using the Web SDK. Ensure the SDK is initialized before calling this method. ```typescript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnKickedOffline, () => {}); ``` -------------------------------- ### Browser/Electron/MiniProgram onRecvNewMessages Example Source: https://docs.openim.io/sdks/callback/onRecvNewMessages This example demonstrates how to subscribe to the OnRecvNewMessages event using the SDK in a browser, Electron, or MiniProgram environment. It shows how to access the new message data from the event payload. ```typescript 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.on(CbEvents.OnRecvNewMessages, ({ data }) => { // data: new message list }); ``` -------------------------------- ### uni-app Call Example Source: https://docs.openim.io/sdks/callback/onFriendApplicationRejected Example of how to use the onFriendApplicationRejected callback in a uni-app environment. It shows how to subscribe to the event and process the rejected friend application data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnFriendApplicationRejected, ({ data }) => { // data: friend application }); ``` -------------------------------- ### uni-app SDK Call Example Source: https://docs.openim.io/sdks/callback/onNewConversation Example of how to subscribe to the OnNewConversation event using the uni-app SDK. It shows how to register a listener for new conversations and access the conversation information. ```javascript import IMSDK from 'openim-uniapp- અpolyfill'; IMSDK.subscribe( IMSDK.IMEvents.OnNewConversation, ({ data }: WSEvent) => { // data: conversation info } ); ``` -------------------------------- ### Web/Electron/MiniProgram Call Example Source: https://docs.openim.io/sdks/callback/onFriendApplicationRejected Example of how to use the onFriendApplicationRejected callback in a web, Electron, or MiniProgram environment using the SDK. It demonstrates how to subscribe to the event and access the rejected friend application data. ```javascript 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.on(CbEvents.OnFriendApplicationRejected, ({ data }) => { // data: friend application }); ``` -------------------------------- ### Call Example for C2C Read Receipt (uni-app) Source: https://docs.openim.io/sdks/callback/onRecvC2CReadReceipt This example shows how to subscribe to the OnRecvC2CReadReceipt event using the openim-uniapp-polyfill library. It logs the received read receipt data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnRecvC2CReadReceipt, ({ data }) => { // data: read receipt list }); ``` -------------------------------- ### Web SDK Call Example Source: https://docs.openim.io/sdks/callback/onNewConversation Example of how to register the onNewConversation callback using the Web SDK. It demonstrates subscribing to the OnNewConversation event and handling the received conversation data. ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on( CbEvents.OnNewConversation, ({ data }: WSEvent) => { // data: conversation info } ); ``` -------------------------------- ### Registering onSyncServerStart Callback (uni-app) Source: https://docs.openim.io/sdks/callback/onSyncServerStart Example of how to register the onSyncServerStart callback in a uni-app environment. This uses the IMSDK.subscribe method with IMSDK.IMEvents.OnSyncServerStart. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerStart, () => {}); ``` -------------------------------- ### Uni-app Call Example Source: https://docs.openim.io/sdks/callback/onGroupInfoChanged Example of subscribing to the onGroupInfoChanged event in a uni-app environment using the provided polyfill. The callback receives an object with group info data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupInfoChanged, ({ data }) => { // data: group info }); ``` -------------------------------- ### uni-app Call Example Source: https://docs.openim.io/sdks/callback/onGroupApplicationAdded Example of how to subscribe to the OnGroupApplicationAdded event using the IMSDK in a uni-app environment. This allows handling group join applications within uni-app projects. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationAdded, ({ data }) => { // data: group join application }); ``` -------------------------------- ### JavaScript Call Example for onGroupApplicationDeleted (uni-app) Source: https://docs.openim.io/sdks/callback/onGroupApplicationDeleted This example shows how to subscribe to the OnGroupApplicationDeleted event in a uni-app environment using the openim-uniapp-polyfill library. It demonstrates the event subscription mechanism for group application deletions. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationDeleted, ({ data }) => { // data: group join application }); ``` -------------------------------- ### Native SDK (Android/Flutter/etc.) Example Source: https://docs.openim.io/sdks/callback/onRecvOfflineNewMessage Illustrates the native callback signature for receiving offline messages. ```APIDOC ## onRecvOfflineNewMessage Callback ### Description This callback is invoked when the application receives a new offline message while running in the background. It provides a single message object. ### Prototype ```java void onRecvOfflineNewMessage(Message msg) ``` ### Parameters - **msg** (Message) - Required. The newly received offline message object. ``` -------------------------------- ### JavaScript/Browser/Electron/MiniProgram Call Example Source: https://docs.openim.io/sdks/callback/onJoinedGroupDeleted Example of how to use the onJoinedGroupDeleted callback in JavaScript for browser, Electron, or MiniProgram environments. It uses the IMSDK to subscribe to the event. ```javascript 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.on(CbEvents.OnJoinedGroupDeleted, ({ data }) => { // data: group info }); ``` -------------------------------- ### Uni-app SDK Call Example for onKickedOffline Source: https://docs.openim.io/sdks/callback/onKickedOffline Example of how to subscribe to the OnKickedOffline event using the Uni-app SDK. This uses the subscribe method for event handling. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnKickedOffline, () => {}); ``` -------------------------------- ### Call Example - uni-app SDK Source: https://docs.openim.io/sdks/callback/onFriendDeleted This example shows how to subscribe to the OnFriendDeleted event using the openim-uniapp-polyfill SDK. It illustrates the method for receiving friend deletion notifications in a uni-app environment. ```typescript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnFriendDeleted, ({ data }) => { // data: friend info }); ``` -------------------------------- ### JavaScript Call Example Source: https://docs.openim.io/sdks/callback/onJoinedGroupAdded Example of how to use the onJoinedGroupAdded callback in a JavaScript environment, typically within a web or Electron application. Ensure the SDK is properly initialized. ```javascript 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.on(CbEvents.OnJoinedGroupAdded, ({ data }) => { // data: group info }); ``` -------------------------------- ### Registering onSyncServerStart Callback (WASM SDK) Source: https://docs.openim.io/sdks/callback/onSyncServerStart Example of how to register the onSyncServerStart callback using the WASM SDK. This involves importing the SDK and using the 'on' method with the CbEvents.OnSyncServerStart event. ```typescript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnSyncServerStart, () => {}); ``` -------------------------------- ### Call Example - Web/Electron/MiniProgram SDK Source: https://docs.openim.io/sdks/callback/onFriendDeleted This example demonstrates how to use the onFriendDeleted callback with the OpenIM SDK in web, Electron, or MiniProgram environments. It shows how to register the callback to receive friend deletion notifications. ```typescript 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.on(CbEvents.OnFriendDeleted, ({ data }) => { // data: friend info }); ``` -------------------------------- ### Call Example for OnFriendApplicationAdded (uni-app) Source: https://docs.openim.io/sdks/callback/onFriendApplicationAdded Shows how to subscribe to the OnFriendApplicationAdded event using the OpenIM uni-app polyfill. It logs the received friend application data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnFriendApplicationAdded, ({ data }) => { // data: friend application }); ``` -------------------------------- ### JavaScript Call Example for onGroupApplicationDeleted Source: https://docs.openim.io/sdks/callback/onGroupApplicationDeleted This example demonstrates how to use the onGroupApplicationDeleted callback in a JavaScript environment, likely for web or Electron applications. It shows how to subscribe to the event using the SDK. ```javascript 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.on(CbEvents.OnGroupApplicationDeleted, ({ data }) => { // data: group join application }); ``` -------------------------------- ### Uni-app Call Example Source: https://docs.openim.io/sdks/callback/onJoinedGroupAdded Example of subscribing to the OnJoinedGroupAdded event in a Uni-app environment using the openim-uniapp-polyfill library. The callback receives event data containing group information. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnJoinedGroupAdded, ({ data }) => { // data: group info }); ``` -------------------------------- ### uni-app SDK Call Example Source: https://docs.openim.io/sdks/callback/onTotalUnreadMessageCountChanged Illustrates how to subscribe to the OnTotalUnreadMessageCountChanged event using the openim-uniapp-polyfill SDK. It shows the event subscription mechanism and how to access the unread count data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnTotalUnreadMessageCountChanged, ({ data }) => { // data: message unread count }); ``` -------------------------------- ### onSyncServerStart Callback Source: https://docs.openim.io/sdks/callback/onSyncServerStart Callback when syncing conversations with the server starts. ```APIDOC ## onSyncServerStart ### Description Callback when syncing conversations with the server starts. ### Platforms * iOS * Android * Flutter * uni-app * Browser/Electron/MiniProgram * Unity ### Call Example (JavaScript SDK) ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnSyncServerStart, () => { console.log('Sync server start'); }); ``` ### Call Example (uni-app SDK) ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerStart, () => { console.log('Sync server start'); }); ``` ``` -------------------------------- ### JavaScript Call Example for onFriendApplicationDeleted (uni-app) Source: https://docs.openim.io/sdks/callback/onFriendApplicationDeleted This JavaScript example shows how to subscribe to the OnFriendApplicationDeleted event using the openim-uniapp-polyfill library. It provides a callback function that receives the friend application data. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnFriendApplicationDeleted, ({ data }) => { // data: friend application }); ``` -------------------------------- ### JavaScript Call Example for onFriendApplicationDeleted Source: https://docs.openim.io/sdks/callback/onFriendApplicationDeleted This JavaScript example demonstrates how to use the onFriendApplicationDeleted callback with the OpenIM SDK. It shows how to subscribe to the event and access the deleted friend application data. ```javascript 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.on(CbEvents.OnFriendApplicationDeleted, ({ data }) => { // data: friend application }); ``` -------------------------------- ### Call Example for C2C Read Receipt (JavaScript/TypeScript) Source: https://docs.openim.io/sdks/callback/onRecvC2CReadReceipt This example demonstrates how to subscribe to the OnRecvC2CReadReceipt event using the OpenIM SDK in a JavaScript/TypeScript environment, such as Electron or Mini Programs. It logs the received read receipt data. ```javascript 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.on(CbEvents.OnRecvC2CReadReceipt, ({ data }) => { // data: read receipt list }); ``` -------------------------------- ### Registering Input Status Changed Callback (Electron/Mini Program) Source: https://docs.openim.io/sdks/callback/onInputStatusChanged Example of how to register the onInputStatusChanged callback using the SDK in Electron or Mini Program environments. ```javascript 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.on(CbEvents.onInputStatusChanged, ({ data }) => { // data }); ``` -------------------------------- ### Registering onUserStatusChanged Callback (JavaScript/Electron/MiniProgram) Source: https://docs.openim.io/sdks/callback/onUserStatusChanged Example of how to register the onUserStatusChanged callback using the IMSDK in JavaScript environments like Electron or Mini Programs. Ensure the SDK is correctly imported for your environment. ```javascript 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.on( CbEvents.OnUserStatusChanged, ({ data }) => {} ); ``` -------------------------------- ### JavaScript SDK Call Example Source: https://docs.openim.io/sdks/callback/onGroupMemberAdded Example of how to use the onGroupMemberAdded callback with the OpenIM JavaScript SDK. This snippet shows how to subscribe to the event and access the group member data. ```javascript 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.on(CbEvents.OnGroupMemberAdded, ({ data }) => { // data: group member info }); ``` -------------------------------- ### Import SDK in Electron Renderer Process Source: https://docs.openim.io/sdks/quickstart/electron Import and get the SDK instance in your Electron application's renderer process. ```javascript import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; const { instance } = getWithRenderProcess(); export const IMSDK = instance; ``` -------------------------------- ### Add Dependencies for Electron Source: https://docs.openim.io/sdks/quickstart/electron Install the necessary OpenIM SDK packages for your Electron project using npm. ```bash npm install @openim/wasm-client-sdk @openim/electron-client-sdk --save ``` -------------------------------- ### uni-app SDK Usage Source: https://docs.openim.io/sdks/callback/onSyncServerFailed Example of how to subscribe to the OnSyncServerFailed event using the uni-app SDK. ```APIDOC ## Call Example (uni-app SDK) ### Description This example shows how to subscribe to the `OnSyncServerFailed` event using the `subscribe` method in the uni-app SDK. ### Code ```javascript import IMSDK from 'openim-uniapp- સાયકલીસ્ટ-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerFailed, () => { // Handle sync server failed event }); ``` ``` -------------------------------- ### JavaScript SDK Usage Source: https://docs.openim.io/sdks/callback/onSyncServerFailed Example of how to subscribe to the OnSyncServerFailed event using the JavaScript SDK. ```APIDOC ## Call Example (JavaScript SDK) ### Description This example demonstrates how to use the `on` method to listen for the `OnSyncServerFailed` event. ### Code ```javascript import { getSDK } from '@openim/wasm-client-sdk'; const IMSDK = getSDK(); IMSDK.on(CbEvents.OnSyncServerFailed, () => { // Handle sync server failed event }); ``` ``` -------------------------------- ### Subscribing to Input Status Changed (uni-app) Source: https://docs.openim.io/sdks/callback/onInputStatusChanged Example of how to subscribe to the onInputStatusChanged event in a uni-app environment. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe('onInputStatusChanged', (data) => { // data }); ``` -------------------------------- ### Call onSyncServerFinish with Uni-app SDK Source: https://docs.openim.io/sdks/callback/onSyncServerFinish Example of how to subscribe to the OnSyncServerFinish event using the uni-app SDK. This is used for uni-app development. ```javascript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe(IMSDK.IMEvents.OnSyncServerFinish, () => {}); ``` -------------------------------- ### TypeScript/JavaScript Call Example (uni-app) Source: https://docs.openim.io/sdks/callback/onConversationChanged Shows how to subscribe to the OnConversationChanged event in a uni-app environment using the openim-uniapp-polyfill library. It provides a callback function that receives conversation data. ```typescript import IMSDK from 'openim-uniapp-polyfill'; IMSDK.subscribe( IMSDK.IMEvents.OnConversationChanged, ({ data }: WSEvent) => { // data: conversation info } ); ```