跳到内容

Android 上的自定义通话事件处理程序

自定义通话事件处理程序是您自己的 Java 类,用于在原生 Android 端接收 VoIP 通话事件。您可以用它在用户接听时打开自己的通话界面,或将通话事件传递到主 WebView 无法触及的应用部分,例如带有独立 WebView 的第二个 activity。

处理程序的工作原理

Anchor link to
  • 对于每个通话事件,插件会先将 JavaScript 事件发送到主 WebView,然后调用您的处理程序。您的 registerEvent 监听器会继续工作。
  • 设置处理程序后,插件在用户接听时不会将应用切换到前台。没有处理程序时,插件会打开应用的启动器 activity。有处理程序时,请在 onAnswer 中打开您的界面,否则应用会停留在后台。
  • 应用进程启动后,插件会在第一个通话事件时从应用清单中读取类名,并通过反射创建该类。该类需要一个无参数的公共构造函数。
  • 回调不会收到 Context。请在应用中保存一个应用 Context,例如保存在您的 Application 子类中,就像下面示例中的 MyApp.context() 那样。

通话事件

Anchor link to

处理程序实现 com.pushwoosh.calls.listener.CallEventListener。请实现全部八个方法,不需要的方法留空即可。

方法调用时机JavaScript 事件
onCreateIncomingConnection(Bundle payload)来电开始响铃voipPushPayload
onAnswer(PushwooshVoIPMessage message, int videoState)用户接听answer
onReject(PushwooshVoIPMessage message)用户拒接reject
onDisconnect(PushwooshVoIPMessage message)通话结束hangup
onCallCancelled(PushwooshVoIPMessage message)取消推送取消了通话voipDidCancelCall
onCallCancellationFailed(String callId, String reason)无法应用取消推送voipDidFailToCancelCall
onCallAdded(PushwooshVoIPMessage message)系统通话服务添加了通话无
onCallRemoved(PushwooshVoIPMessage message)系统通话服务移除了通话无

PushwooshVoIPMessage 提供 VoIP 推送中的值:

Getter返回值
getCallId()callId;如果推送中没有,则为 null
getCallerName()callerName;如果推送中没有,则为 Unknown Caller
getHasVideo()video
getSupportsHolding()supportsHolding
getSupportsDTMF()supportsDTMF
getCancelCall()cancelCall
getRawPayload()完整的推送 Bundle,包括您的自定义键

onCreateIncomingConnection 接收原始 Bundle。要在其中使用这些 getter,请将其包装:new PushwooshVoIPMessage(payload)。

1. 在清单中注册处理程序

Anchor link to

在 <application> 中添加一个 meta-data 条目,填写处理程序的完整类名:

<application ...>
<meta-data
android:name="com.pushwoosh.cordova.CALL_EVENT_HANDLER"
android:value="com.example.app.MyCallEventHandler" />
</application>

步骤 3 说明了该条目在 Cordova 和 Capacitor 中应放在何处。

2. 编写处理程序

Anchor link to

此处理程序在用户接听时打开您的通话界面,并将每个通话事件作为应用内广播发送:

public class MyCallEventHandler implements CallEventListener {
public static final String ACTION_CALL_EVENT = "com.example.app.CALL_EVENT";
/**
* Called when the user answers the call.
* Opens the app on the call screen and broadcasts the event to the rest of the app.
*/
@Override
public void onAnswer(@NonNull PushwooshVoIPMessage message, int videoState) {
Context context = MyApp.context(); // your application Context
Intent intent = new Intent(context, VideoCallActivity.class)
.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
| Intent.FLAG_ACTIVITY_CLEAR_TOP
| Intent.FLAG_ACTIVITY_SINGLE_TOP)
.putExtra("callId", message.getCallId());
context.startActivity(intent);
broadcast("answer", message);
}
@Override
public void onReject(@NonNull PushwooshVoIPMessage message) {
broadcast("reject", message);
}
@Override
public void onDisconnect(@NonNull PushwooshVoIPMessage message) {
broadcast("hangup", message);
}
@Override
public void onCallCancelled(@NonNull PushwooshVoIPMessage message) {
broadcast("cancelled", message);
}
@Override public void onCreateIncomingConnection(@Nullable Bundle payload) {}
@Override public void onCallAdded(@NonNull PushwooshVoIPMessage message) {}
@Override public void onCallRemoved(@NonNull PushwooshVoIPMessage message) {}
@Override public void onCallCancellationFailed(@Nullable String callId, @NonNull String reason) {}
private static void broadcast(String event, PushwooshVoIPMessage message) {
Context context = MyApp.context(); // your application Context
Intent intent = new Intent(ACTION_CALL_EVENT)
.setPackage(context.getPackageName())
.putExtra("event", event)
.putExtra("callId", message.getCallId());
context.sendBroadcast(intent);
}
}

3. 将代码添加到您的项目

Anchor link to

将处理程序类添加到 android/app/src/main/java/,并将步骤 1 中的 meta-data 条目添加到 android/app/src/main/AndroidManifest.xml。

在 android/app/build.gradle 中将 Pushwoosh calls SDK 添加到应用模块。请使用插件的 src/android/add-android-voip.gradle 中设置的版本:

dependencies {
compileOnly "com.pushwoosh:pushwoosh-calls:6.17.1"
}

如果不添加,构建会失败并报错 package com.pushwoosh.calls.listener does not exist,因为插件只会将 calls SDK 添加到它自己的模块中。

Cordova 会重新生成原生项目,因此请通过本地插件添加处理程序。其 plugin.xml 会复制该类并将 meta-data 添加到清单中:

<platform name="android">
<source-file src="src/android/MyCallEventHandler.java" target-dir="src/com/example/app" />
<config-file target="AndroidManifest.xml" parent="/manifest/application">
<meta-data android:name="com.pushwoosh.cordova.CALL_EVENT_HANDLER"
android:value="com.example.app.MyCallEventHandler" />
</config-file>
</platform>

Cordova 不需要额外的 Gradle 依赖。

相关链接

Anchor link to