概览
“概览”章节启动检索器,监听 smsReceived,从短信正文中提取数字 OTP,并验证你的服务器为 Retriever API 追加的末尾 11 位应用哈希。
平台支持
标题为“平台支持”的部分| 平台 | 支持 | 备注 |
|---|---|---|
| iOS | 否 | 使用自动填充或通行密钥 |
| Android | 是 | SMS Retriever API |
| Web 端 | 否 | 不适用 |
核心功能
标题为“核心功能”的章节startWatch- 启动为期 5 分钟的 SMS Retriever 监听,以获取一条验证短信。stopWatch- 停止当前的 SMS Retriever 监听。getHashString- 读取验证短信中使用的 11 位应用哈希值 (app hash)。getPhoneNumber- 打开 Android Phone Number Hint 并返回所选手机号。smsReceived- 监听已获取的验证短信。smsRetrieverTimeout- 监听 5 分钟超时事件。smsRetrieverError- 监听来自 Android 或 Google Play services 的运行时错误。
平台支持
“平台支持”章节| 平台 | 支持 |
|---|---|
| Android | 支持 |
| iOS | 不支持的 stub |
| Web 端 | 不支持的 stub |
公开 API
标题为“公开 API”的章节| 方法 | 描述 |
|---|---|
startWatch | 开始监听一条验证短信。 |
stopWatch | 停止当前的监听。 |
getHashString | 返回 11 位 App Hash。 |
getPhoneNumber | 显示手机号提示并返回所选号码。 |
addListener('smsReceived', ...) | 接收获取到的短信内容。 |
addListener('smsRetrieverTimeout', ...) | 处理超时事件。 |
addListener('smsRetrieverError', ...) | 处理检索错误。 |
getPluginVersion | 返回原生插件版本。 |
单一事实来源
标题为“单一事实来源”的部分此参考文档同步自 src/definitions.ts 中的 capacitor-android-sms-retriever.
继续阅读 @capgo/capacitor-android-sms-retriever
标题为“继续阅读 @capgo/capacitor-android-sms-retriever”的章节如果你正在使用 @capgo/capacitor-android-sms-retriever 要规划原生插件工作,请将其与 使用 @capgo/capacitor-android-sms-retriever 用于“使用 @capgo/capacitor-android-sms-retriever”中的原生能力, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 关于“添加或更新插件”中的实现细节,以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。