模板版本:v0.4.0

react-native-callkeep

本项目基于 react-native-callkeep 开发。

该第三方库的仓库在Github上,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-callkeep 版本所属关系如下:

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-callkeep ~ 4.3.15 Github Releases 0.72.*/0.77.*/0.82.* partially(0.72/0.82) API12+ 4.3.14 Npm Address
@react-native-oh-tpl/react-native-callkeep <= 4.3.14-0.0.1@deprecated Github Releases(deprecated) 0.72.* API12+ 4.3.14 Npm Address

1. 安装与使用

进入到工程目录并输入以下命令:

npm

npm install @react-native-ohos/react-native-callkeep

yarn

yarn add @react-native-ohos/react-native-callkeep

下面的代码展示了这个库的基本使用场景:

使用时 import 的库名不变。

import {
    Button,
    Alert,
    Text,
} from 'react-native';

import RNCallKeep from 'react-native-callkeep';

export function CallKeepExample() {
    const handleClick = (buttonId: number) => {
        switch (buttonId) {
            case 1:
                RNCallKeep.startCall("0x123456", "10086");
                break;
            case 2:
                RNCallKeep.isCallActive("0x123456").then(res => {
                    Alert.alert('isCallActive value:' + res);
                });
                break;
            case 3:
                RNCallKeep.checkIfBusy().then(res => {
                    Alert.alert('checkIfBusy value:' + res);
                });
                break;

            default:
                break;
        }
    };
    return (
        <>
            <Text style={{ color: "red" }}>RNCallKeep.startCall</Text>
            <Button title='startCall' onPress={() => handleClick(1)} ></Button>

            <Text style={{ color: "red" }}>RNCallKeep.isCallActive</Text>
            <Button title='isCallActive' onPress={() => handleClick(2)} ></Button>

            <Text style={{ color: "red" }}>RNCallKeep.checkIfBusy</Text>
            <Button title='checkIfBusy' onPress={() => handleClick(3)} ></Button>
        </>
    );
}
是否支持autolink RN框架版本
~4.3.15 partially(0.72/0.82) 0.72/0.77/0.82
<= 4.3.14-0.0.1@deprecated No 0.72

使用AutoLink的工程需要根据该文档配置,Autolink框架指导文档:https://gitcode.com/openharmony-sig/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md

如您使用的版本支持 Autolink,并且工程已接入 Autolink,可跳过ManualLink配置。

ManualLink: 此步骤为手动配置原生依赖项的指导

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

2.1. Overrides RN SDK

为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.72.38" // ohpm 在线版本
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
  }
}

2.2. 引入原生端代码

目前有两种方法:

  • 通过 har 包引入;
  • 直接链接源码。

方法一:通过 har 包引入(推荐)

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5,添加以下依赖

"dependencies": {
    "@react-native-ohos/react-native-callkeep": "file:../../node_modules/@react-native-ohos/react-native-callkeep/harmony/call_keep.har"
  }

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

2.3. 配置 CMakeLists 和引入 CallKeepPackage

打开 entry/src/main/cpp/CMakeLists.txt,添加:

+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")

# RNOH_BEGIN: manual_package_linking_1
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-callkeep/src/main/cpp" ./callkeep)
# RNOH_END: manual_package_linking_1

# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_call_keep)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "CallKeepPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
        std::make_shared<RNOHGeneratedPackage>(ctx),
+       std::make_shared<CallKeepPackage>(ctx)
    };
}

2.4. 在 ArkTs 侧引入 RNCallKeepPackage

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

  ...
+ import { RNCallKeepPackage } from '@react-native-ohos/react-native-callkeep';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
+   new RNCallKeepPackage(ctx),
  ];
}

2.5. 运行

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

然后编译、运行即可。

3. 约束与限制

3.1. 兼容性

本文档内容基于以下版本验证通过:

  1. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  2. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
  3. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.82.7; SDK: HarmonyOS 6.1.0 Release SDK; IDE: DevEco Studio 6.1.0.830; ROM: 6.0.0.130;

4. 静态方法

"Platform"列表示该属性在原三方库上支持的平台。

"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。

Name Description Type Required Platform HarmonyOS Support
isCallActive() 检查指定通话是否处于活动状态(用户已接听该通话) RNCallKeep.isCallActive(uuid) no iOS yes
checkIfBusy() 检查设备当前是否存在活动通话 RNCallKeep.checkIfBusy() no iOS yes
getCalls() 返回 Promise,结果为当前所有通话及其状态的数组 RNCallKeep.getCalls() no iOS no
checkSpeaker() 检查扬声器是否开启,并返回包含布尔值的 Promise RNCallKeep.checkSpeaker() no iOS no
startCall() 发起外呼 RNCallKeep.startCall(uuid, handle, contactIdentifier, handleType, hasVideo) no ALL yes
displayIncomingCall() 显示系统来电界面 RNCallKeep.displayIncomingCall() no ALL no
answerIncomingCall() 当用户在应用界面接听电话时通知 SDK RNCallKeep.answerIncomingCall(uuid) no ALL no
updateDisplay() 外呼开始后更新通话显示信息 RNCallKeep.updateDisplay(uuid, displayName, handle) no ALL no
endCall() 结束当前来电或去电 RNCallKeep.endCall(uuid) no ALL no
endAllCalls() 结束所有正在进行的通话 RNCallKeep.endAllCalls() no ALL no
rejectCall() 拒接来电 RNCallKeep.rejectCall(uuid) no ALL no
reportEndCallWithUUID() 上报非用户主动结束的通话 RNCallKeep.reportEndCallWithUUID(uuid, reason) no ALL no
setMutedCall() 打开或关闭麦克风静音 RNCallKeep.setMutedCall(uuid, true) no ALL no
setOnHold() 设置通话保持/恢复 RNCallKeep.setOnHold(uuid, true) no ALL no
removeEventListener() 移除事件监听器 RNCallKeep.removeEventListener() no ALL no
setup() 初始化 RNCallKeep,允许在 React Native Bridge 启动前捕获事件 RNCallKeep.setup() no ALL no
setSettings() 初始化运行配置 RNCallKeep.setSettings() no ALL no
getAudioRoutes() 获取可用音频路由列表(蓝牙、耳机、扬声器、听筒等) RNCallKeep.getAudioRoutes() no ALL no
setAudioRoute() 设置音频输出路由 RNCallKeep.setAudioRoute(uuid, routeName) no ALL no
getInitialEvents() 获取初始化期间缓存的事件(事件监听的替代方案) RNCallKeep.getInitialEvents() no ALL no
clearInitialEvents() 清除所有待处理的初始化事件 RNCallKeep.clearInitialEvents() no ALL no
setAvailable() 通知 Android ConnectionService 当前设备已准备好发起电话 RNCallKeep.setAvailable(true) no Android no
setForegroundServiceSettings() 配置前台服务(Foreground Service) RNCallKeep.setForegroundServiceSettings() no Android no
canMakeMultipleCalls() 禁用 ConnectionService 界面的“添加通话”按钮 RNCallKeep.canMakeMultipleCalls(false) no Android no
setCurrentCallActive() 将当前通话标记为活动状态 RNCallKeep.setCurrentCallActive(uuid) no Android no
checkIsInManagedCall() 检查当前是否存在活动的系统电话 RNCallKeep.checkIsInManagedCall() no Android no
setConnectionState() 修改通话连接状态 RNCallKeep.setConnectionState(uuid, state) no Android no
toggleAudioRouteSpeaker() 切换音频服务的扬声器输出状态 RNCallKeep.toggleAudioRouteSpeaker(uuid, true) no Android no
backToForeground() 当应用在后台时,将应用切换回前台 RNCallKeep.backToForeground() no Android no
registerPhoneAccount() 手动注册 Android Phone Account RNCallKeep.registerPhoneAccount(options) no Android no
registerEvents() 注册 Android 初始化事件 RNCallKeep.registerAndroidEvents() no Android no
sendDTMF() 发送 DTMF 按键音(电话拨号音) RNCallKeepModule.sendDTMF(uuid, key) no Android no
unregisterEvents() 注销 Android 初始化事件 RNCallKeep.unregisterAndroidEvents() no Android no
setReachable() 在原生电话应用发起通话前检查应用是否可达 RNCallKeep.setReachable() no Android no
supportConnectionService() 判断设备是否支持 ConnectionService RNCallKeep.supportConnectionService() no Android no
hasPhoneAccount() 检查用户是否已启用应用的 Phone Account RNCallKeep.hasPhoneAccount() no Android no
hasOutgoingCall() 检查后台唤醒时是否存在外呼 RNCallKeep.hasOutgoingCall() no Android no
hasDefaultPhoneAccount() 检查用户是否设置了默认 Phone Account RNCallKeep.hasDefaultPhoneAccount(options) no Android no
checkPhoneAccountEnabled() 检查默认 Phone Account 是否已启用 RNCallKeep.checkPhoneAccountEnabled() no Android no
isConnectionServiceAvailable() 检查设备是否支持 ConnectionService RNCallKeep.isConnectionServiceAvailable() no Android no

5. 遗留问题

6. 其他

7. 开源协议

本项目基于 The ISC License (ISC) ,请自由地享受和参与开源。