@capgo/capor-android-sms-retriever (英语)

使用Google Play服务SMS Retriever在未经短信许可的情况下从Android上的短信中读取一次性代码,让用户用Phone Number Hint来取电话号码. 更平滑的登录和核查流量.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-android-sms-retriever 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 加上@capgo/capor-android-sms-retriever到我的Capacitor应用上并把它接上 代理设置指南 • 妇女 主机磁共振

主要特点

• 短消息检索器数字 : startWatch() 等待一个验证短消息和发送 smsReceived,与 smsRetrieverTimeout 财务报告和审定财务报表 smsRetrieverError 事件.
• 没有短消息权限: Google Play 服务发送匹配的消息, 所以你不请求 READ_SMS。 。 。 .
• 应用散列数字 : getHashString() 返回您服务器添加到短消息中的11个字符的散列.
• 电话号码提示数字 : getPhoneNumber() 显示系统拾取器并返回选定的SIM编号.
• 随时停止数字 : stopWatch() 取消活动监视.
• 平台:Android (英语). 仅限Android. iOS和网络不支持.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-android-sms-retriever` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

bun add @capgo/capacitor-android-sms-retriever
bunx cap sync android

机器人

此插件不请求短消息权限 。 短消息检索使用Google Play服务,并等待一个匹配的验证短消息,最多5分钟.

校验的短消息必须包含 app hash 返回 getHashString()。 。 。 .

使用量

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

const { hash } = await AndroidSmsRetriever.getHashString();
console.log('SMS hash:', hash);

const received = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  console.log('Verification SMS:', message);
});

await AndroidSmsRetriever.addListener('smsRetrieverTimeout', () => {
  console.log('SMS Retriever timed out');
});

await AndroidSmsRetriever.startWatch();

// Later, if needed:
await AndroidSmsRetriever.stopWatch();
await received.remove();

const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();
console.log(phoneNumber);

API 密码

• startWatch()
• stopWatch()
• getHashString()
• getPhoneNumber()
• addListener('smsReceived', ...)
• addListener('smsRetrieverTimeout', ...)
• addListener('smsRetrieverError', ...)
• removeAllListeners()
• getPluginVersion()
• 接口
• 类型异名

用于Google Play服务SMS Retriever和Phone Number Hint APIs的Android-唯一Capacitor插件.

开始监视( C)

startWatch() => Promise<StartWatchResult>

开始通过Android的"SMS Retriever API"监听一次验证短消息.

Android 在匹配消息到达时或之后自动停止监听 5分钟短消息 恢复时间。 不需要短消息权限 .

回返情况: Promise<StartWatchResult>

自: 8.0.0 (单位:千美元)

停止监视( C)

stopWatch() => Promise<StopWatchResult>

停止运行中的短消息 Retriever 手表,如果有的话.

回返情况: Promise<StopWatchResult>

自: 8.0.0 (单位:千美元)

获取HashString ()

getHashString() => Promise<GetHashStringResult>

获取已安装的应用程序签名的 11 个字符的 app 散列 .

为用于分发应用程序的签名密钥生成一次并附加它 以校验短消息.

回返情况: Promise<GetHashStringResult>

自: 8.0.0 (单位:千美元)

获取 Phone 数字( )

getPhoneNumber() => Promise<GetPhoneNumberResult>

显示Android的电话号码Hint UI并返回用户选择的基于SIM的电话号码.

回返情况: Promise<GetPhoneNumberResult>

自: 8.0.0 (单位:千美元)

添加倾听器( 已接收),...)

addListener(eventName: 'smsReceived', listenerFunc: (event: SmsReceivedEvent) => void) => Promise<PluginListenerHandle>

聆听在QQlink start Watch 之后收到的验证短消息 .

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加倾听器( sms RetrieverTimeout),..

addListener(eventName: 'smsRetrieverTimeout', listenerFunc: () => void) => Promise<PluginListenerHandle>

听5分钟的短讯检索时间.

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加倾听器( ssretriever Error",...)

addListener(eventName: 'smsRetrieverError', listenerFunc: (event: SmsRetrieverErrorEvent) => void) => Promise<PluginListenerHandle>

在QQlink start Watch 后聆听短消息 Retriever 运行时间错误 .

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有注册听众 .

自: 8.0.0 (单位:千美元)

获取 PluginVersion ()

getPluginVersion() => Promise<PluginVersionResult>

获取本地 Capacitor 插件版本 .

回返情况: Promise<PluginVersionResult>

自: 8.0.0 (单位:千美元)

接口

开始观察结果

当短消息检索器开始观看时返回结果 .

停止监视结果

当SMS Retriever观看停止时返回结果 .

获取 HashString 结果

由QQlink AndroidSmsRetriever Plugin.getHashString}返回结果.

GetPhone 数字结果

由QQlink AndroidSmstriever Plugin.getPhone Number}返回的结果 .

插件听筒

接收事件

SMS Retriever 消息事件有效载荷.

Smsretriever 错误事件

SMS Retriever 错误事件有效载荷 .

插件变压器

插件版本有效载荷 .

类型异名

SmsRetriever 开始状态

状态值由 QQlink AndroidSmsRetriever Plugin. start Watch 返回 .

'SMS_RETRIEVER_STARTED' | 'SMS_RETRIEVER_ALREADY_STARTED'