setAppBackgroundStatus

功能介绍

说明

设置应用是否在后台运行，当应用切换前后台状态时调用。

uni-app

函数原型

IMSDK.setAppBackgroundStatus(isBackgroud: boolean, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
isBackgroud	boolean	是	应用是否在后台运行

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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 { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();

IMSDK.setAppBackgroundStatus(true)
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('setAppBackgroundStatus', operationID: string, isBackgroud: boolean): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
isBackgroud	boolean	是	应用是否在后台运行

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setAppBackgroundStatus', IMSDK.uuid(), true)
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.setAppBackgroundStatus(isBackground: boolean, operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
isBackgroud	boolean	是	应用是否在后台运行
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.setAppBackgroundStatus(true, 'operationID');
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void SetAppBackGroundStatus(bool isBackGround, OnSucOrError cb)

输入参数

参数名称	参数类型	是否必填	描述
isBackgroud	bool	是	应用是否在后台运行
cb	OnSucOrError	是	成功或失败调用

返回结果

代码示例

IMSDK.SetAppBackGroundStatus(true,(suc,errCode,errMsg)=>{

});