# @eabdullazyanov/react-native-sms-user-consent 中文文档

规范地址：https://npmcn.com/package/%40eabdullazyanov/react-native-sms-user-consent/

版本：1\.3\.0
npm 元数据更新时间：2025-11-17T15:53:29.204Z
中文译文更新时间：2026-11-13T03:19:56.962Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40eabdullazyanov/react-native-sms-user-consent
原文对照：https://npmcn.com/package/%40eabdullazyanov/react-native-sms-user-consent/?lang=original
项目主页：https://github.com/akvelon/react-native-sms-user-consent#readme
源码仓库：https://github.com/akvelon/react-native-sms-user-consent

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：97.4 kB，27 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16\.8，react-native \>=0\.66
- 首次发布：2021-03-02T14:43:22.420Z
- 最新版本发布：2025-11-17T15:53:29.035Z
- 近 30 天下载量：45242（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 1 个）

## 中文简介

反应原生包装为Android的短消息用户同意 API,准备在反应原生应用程序中使用,尽量不费力

## 安装

```sh
npm install @eabdullazyanov/react-native-sms-user-consent
```

也可以使用：`pnpm add @eabdullazyanov/react-native-sms-user-consent`、`yarn add @eabdullazyanov/react-native-sms-user-consent`、`bun add @eabdullazyanov/react-native-sms-user-consent`

## README

# 反应原生短消息用户同意

反应原生包装为Android的SMS用户同意API,准备在反应原生应用程序中使用并尽量少用. 短信用户同意API的目的是提供单塔自动填充短信验证码.

## iOS系统

短消息用户同意API只存在于Android上,因此这个包只存在于Android上. 在iOS上调用这个软件包的API是没有的.

如果你想在iOS上自动填充, `textContentType="oneTimeCode"` 页:1 `TextInput` 是该走了。 基本上,这是iOS的唯一方法.

## 开始

安装 [软件包](https://www.npmjs.com/package/@eabdullazyanov/react-native-sms-user-consent)数字 :

```
yarn add @eabdullazyanov/react-native-sms-user-consent
```

或者说

```
npm install @eabdullazyanov/react-native-sms-user-consent
```

## 基本用途

```javascript
import React, { useEffect, useState } from 'react';
import { TextInput } from 'react-native';

import { useSmsUserConsent } from '@eabdullazyanov/react-native-sms-user-consent';

const Example = () => {
  const [code, setCode] = useState();

  const retrievedCode = useSmsUserConsent();

  useEffect(() => {
    if (retrievedCode) setCode(retrievedCode);
  }, [retrievedCode]);

  return <TextInput value={code} onChangeText={setCode} />;
};
```

举个例子,我们用控制器 `TextInput` 代码条目. `retrievedCode` 初始等于空字符串, 当处理短消息时 `retrievedCode` 从它得到代码。 我们使用 `useEffect` 用于处理短信时更新输入值.

### 自定义校验代码解析器

设定验证代码的长度 :

```typescript
const retrievedCode = useSmsUserConsent(4);
// e.g. code = 1234
```

提供自定义正则表达式 :

```typescript
const retrievedCode = useSmsUserConsent('[A-Z0-9]{5}');
// e.g. code = A12B3
```

## API 密码

### 用户同意( )

```typescript
useSmsUserConsent(config: number | string): string
```

启动短消息处理并作为其返回值提供已接收代码的反向钩,这是最初的空字符串. 停止在卸载时处理短消息 。 用途 `startSmsHandling` 财务报告和审定财务报表 `retrieveVerificationCode` 内部.

这种钩子在多数情况下都是走道. 或者,你可以使用 `startSmsHandling` 财务报告和审定财务报表 `retrieveVerificationCode` 直接处理不是功能组件的东西,或者你需要一些更大的灵活性.

在iOS上,它只是返回了空字符串,所以不需要额外的代码来处理iOS.

接受可选选项 `config` 参数。 如果是一个数字,它定义了代码的长度. 如果是字符串,它定义了自定义的RegExp来解析代码.

### 启动SmsHandling ()

```typescript
startSmsHandling(onSmsReceived: (event: {sms?: string}) => void): (
  stopSmsHandling(): void
)
```

启动本地短消息监听器, 以显示短消息用户同意系统提示 。 如果用户允许阅读短消息,那么 `onSmsReceived` 召回名为. `onSmsReceived` 收到含有短消息的事件对象.

回返 `stopSmsHandling` 函数,它停止显示系统提示并停止短消息处理.

### 检索验证码( )

```typescript
retrieveVerificationCode(sms: string, config: number | string): string | null
```

如果有的话,从短信处获取核查码.

接受可选选项 `config` 参数。 如果是一个数字,它定义了代码的长度. 如果是字符串,它定义了自定义的RegExp来解析代码.

* * *

_如果您喜欢, 可以将整个 API 导入为一个对象_

```javascript
import SmsUserConsent from 'react-native-sms-user-consent';

// ...
SmsUserConsent.useSmsUserConsent();
// ...
```

## 帮助

如果您对项目有任何想法或发现错误或有问题,请随意用所有相关信息创建问题. 我们致力于尽快作出反应。 以下信息将使解决问题的速度更快:

1.  设备或模拟器模型
2.  机器人版本
3.  您的环境信息 - 输出 `npx react-native info` 命令

## 捐款

公关总是受欢迎的. 如果你愿意为这个项目捐款,请。 最好能向公关提供所有相关信息.

要改变,你需要遵循这些步骤:

1.  复制还原
2.  进行修改
3.  测试更改
4.  创建 PR
5.  🥳

## 常见问题

### @eabdullazyanov/react-native-sms-user-consent 是什么？

反应原生包装为Android的短消息用户同意 API,准备在反应原生应用程序中使用,尽量不费力

### 如何安装 @eabdullazyanov/react-native-sms-user-consent？

在项目目录运行 npm install @eabdullazyanov/react-native-sms-user-consent，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8）、react-native（\>=0\.66）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eabdullazyanov/react-native-sms-user-consent 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @eabdullazyanov/react-native-sms-user-consent 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @eabdullazyanov/react-native-sms-user-consent 可以商用吗？

@eabdullazyanov/react-native-sms-user-consent 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @eabdullazyanov/react-native-sms-user-consent 的下载量有多少？

根据 npm 官方下载统计，@eabdullazyanov/react-native-sms-user-consent 在 2026/10/13 – 2026/11/11 这 30 天内被下载 45,242 次，日均约 1,508 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @eabdullazyanov/react-native-sms-user-consent 还在维护吗？

最新版本 1\.3\.0 发布于 2025/11/17（11 个月前）；至今共发布 15 个版本，其中过去 12 个月发布了 1 个；首次发布于 2021/03/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。