开始
复制一个带有安装步骤和完整的Markdown指南的设置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-sms-retriever`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/android-sms-retriever/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
安装
标题为“安装”您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-android-sms-retriever` plugin in my project.如果您更喜欢手动设置,请运行以下命令安装插件,并按照以下平台特定的说明进行操作:
bun add @capgo/capacitor-android-sms-retrieverbunx cap sync android导入
标题为“导入”import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';Android 要求
标题为“Android 要求”SMS 取回器需要在 Android 设备上安装 Google Play 服务。该插件不会向用户请求 READ_SMS 或 RECEIVE_SMS 权限.
您的验证短信必须包含由 getHashString()为分发应用程序生成签名密钥的哈希值。调试、发布和 Play App Signing 构建可以具有不同的哈希值。
等待验证短信
标题:等待验证短信import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';
const received = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => { const code = message.match(/\b\d{6}\b/)?.[0]; console.log('Verification code:', code);});
const timeout = await AndroidSmsRetriever.addListener('smsRetrieverTimeout', () => { console.log('SMS Retriever timed out');});
const errors = await AndroidSmsRetriever.addListener('smsRetrieverError', ({ message }) => { console.error('SMS Retriever error:', message);});
await AndroidSmsRetriever.startWatch();
// Remove listeners when the verification flow is done.await received.remove();await timeout.remove();await errors.remove();停止观看
标题:停止观看await AndroidSmsRetriever.stopWatch();获取应用程序哈希
标题:获取应用程序哈希const { hash } = await AndroidSmsRetriever.getHashString();console.log(hash);在您的后端发送的验证短信末尾使用此哈希值。
请求手机号码提示
标题:请求手机号码提示const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();console.log(phoneNumber);Android会显示原生手机号码提示UI并返回用户选择的手机号码。
示例短信
标题:示例短信<#> 123456 is your verification code.FA+9qCX9VSu将此哈希值替换为您的应用签名密钥。
继续从Getting Started
标题:继续从Getting Started如果您正在使用 入门 为了规划原生插件工作,连接它与 使用 @capgo/capacitor-android-sms-retriever 原生能力在使用 @capgo/capacitor-android-sms-retriever 中 Capgo 插件目录 产品工作流程在 Capgo 插件目录 中 Capacitor 由 Capgo 提供的插件 在 Capacitor 由 Capgo 提供的插件 中的实现细节 添加或更新插件 在添加或更新插件 中的实现细节 Ionic 企业插件替代方案 为 Ionic Enterprise Plugin Alternatives 产品工作流程.