uni-app

https://uniapp.dcloud.io
Admin
uni-app is a cross-platform front-end development framework built on Vue.js that allows developers...
Tokens:15,967
Snippets:150
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Configure HarmonyOS Installation Channel

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Metadata configuration for the installation channel in the HarmonyOS module.json5 file.

```json
"metadata": [
  {
    "name": "GT_INSTALL_CHANNEL",
  }
]
```

--------------------------------

### Cloud Function Event for GET Request with Query Parameters

Source: https://uniapp.dcloud.io/uniCloud/http

Example of the event object received by a cloud function when accessed via a GET request with query parameters. Note the 'queryStringParameters' field.

```json
{
    path: '/',
    httpMethod: 'GET',
    headers: {HTTP请求头},
    queryStringParameters: {a: "1", b: "2"},
    isBase64Encoded: false
}
```

--------------------------------

### Cloud Object Method Definition

Source: https://uniapp.dcloud.io/uniCloud/http

Example of a cloud object method definition. The 'params' argument will receive query parameters from the URL when the method is called via URLization.

```javascript
module.exports = {
	addTodo: function(params) { 
		console.log(params)
        return {
            errCode: 0
        }
	}
}
```

--------------------------------

### Perform WeChat Login and Get User Info

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Initiates a login flow using the WeChat provider and subsequently fetches user information. Ensure OAuth is configured in manifest.json and WeChat SDK is applied for.

```javascript
uni.login({
  provider: 'weixin',
  success: function (loginRes) {
    console.log(loginRes.authResult);
    // Get user information
    uni.getUserInfo({
      provider: 'weixin',
      success: function (infoRes) {
      }
    });
  }
});
```

--------------------------------

### UniApp Login Authorization Result

Source: https://uniapp.dcloud.io/univerify

Example of the data structure returned upon successful login authorization. It includes an error message and authentication results such as `openid` and `access_token`.

```json
{
	"errMsg": "login:ok",
	"authResult": {
		"openid": "208E2FBE6EF64DF3B2D377D886EF2A14124262bfd7ae16465ea0f0634554dcee7636",
		"access_token": "ZGI4NjkxZWE4YjAyNGUzMjhiMmZiNDcwODBjYjc5MDF8fDJ8djJ8Mg=="
	}
}

```

--------------------------------

### Verify Signature and Get Phone Number in uniCloud Function

Source: https://uniapp.dcloud.io/univerify

This uniCloud function (Node.js) verifies the incoming request signature and then uses uniCloud.getPhoneNumber to retrieve the user's phone number. It expects parameters and a signature in the GET request.

```javascript
const crypto = require('crypto')
exports.main = async(event) => {

  const hmac = crypto.createHmac('sha256', secret);

  let params = event.queryStringParameters
  const sign = params.sign
  delete params.sign
  const signStr = Object.keys(params).sort().map(key => {
    return `${key}=${params[key]}`
  }).join('&')

  hmac.update(signStr);

  if(sign!==hmac.digest('hex')){
  }

  const {
    access_token,
    openid
  } = params
  const res = await uniCloud.getPhoneNumber({
  	provider: 'univerify',
  	access_token: access_token,
  	openid: openid
  })
  // Return the phone number to the server
  return res
}

```

--------------------------------

### Get checkbox state

Source: https://uniapp.dcloud.io/univerify

Retrieves the current check status of the protocol checkbox in the login interface.

```javascript
uni.getCheckBoxState({
	success(res){
		console.log(res.errMsg)
	},
	fail(res){
		console.log(res.errCode)
		console.log(res.errMsg)
	}
})
```

--------------------------------

### uniCloud getPhoneNumber Response Structure

Source: https://uniapp.dcloud.io/univerify

This is an example of the JSON response structure returned by the uniCloud.getPhoneNumber API, including data, status code, and headers.

```json
{
	"data": {
		"code": 0,
		"success": true,
		"phoneNumber": "166xxxx6666"
	},
	"statusCode": 200,
	"header": {
		"Content-Type": "application/json; charset=utf-8",
		"Connection": "keep-alive",
		"Content-Length": "53",
		"Date": "Fri, 06 Nov 2020 08:57:21 GMT",
		"X-CloudBase-Request-Id": "xxxxxxxxxxx",
		"ETag": "xxxxxx"
	},
	"errMsg": "request:ok"
}

```

--------------------------------

### Manage One-Click Login with univerifyManager

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Demonstrates how to initialize the login manager, perform pre-login, trigger the login UI with custom styles, and handle button click events.

```javascript
// No need to pass provider when using
const univerifyManager = uni.getUniverifyManager()

// pre-login
// parameters are the same as uni.preLogin
univerifyManager.preLogin()

// Call the one-click login pop-up box
// Only need to pass parameter univerifyStyle
univerifyManager.login({
  univerifyStyle: {
    "fullScreen": true,
    "buttons": {
        "iconWidth": "45px",
        "list": [
            {
                "provider": "apple",
                "iconPath": "/static/apple.png"
            },
            {
                "provider": "weixin",
                "iconPath": "/static/wechat.png"
            }
        ]
    }
  },
  success (res) {
    console.log('login success', res)
  }
})

const callback = (res) => {
  // Get the check status of the one-click login pop-up protocol
  // The parameters are the same as uni.getCheckBoxState
  univerifyManager.getCheckBoxState({
    success(res) {
      console.log("getCheckBoxState res: ", res);
      if (res.state) {
        // Close the one-click login popup
        // The parameters are the same as uni.closeAuthView
        univerifyManager.close()
      }
    }
  })
}

// Subscribe to the custom button click event
univerifyManager.onButtonsClick(callback)
// unsubscribe custom button click event
univerifyManager.offButtonsClick(callback)
```

--------------------------------

### uni.preLogin

Source: https://uniapp.dcloud.io/univerify

Checks if the current device environment supports one-click login and prepares the environment to improve display speed.

```APIDOC
## uni.preLogin

### Description
The pre-login operation determines whether the current device environment supports one-key login. It prepares the environment to significantly improve the speed of displaying the authorized login interface.

### Method
uni.preLogin(options)

### Parameters
#### Request Body
- **provider** (string) - Required - Must be 'univerify'
- **success** (function) - Optional - Callback on success
- **fail** (function) - Optional - Callback on failure

### Request Example
```
uni.preLogin({
	provider: 'univerify',
	success(){},
	fail(res){}
})
```
```

--------------------------------

### Initiate uni.login

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Call uni.login to initiate the login process. The success callback receives login results.

```javascript
uni.login({
  success: function (loginRes) {
    console.log(loginRes.authResult);
  }
});

```

--------------------------------

### uni.preLogin

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Prepares the login process, potentially by showing a loading indicator or performing preliminary checks before initiating the actual login flow.

```APIDOC
## uni.preLogin(OBJECT)

### Description
Prepares the login process, potentially by showing a loading indicator or performing preliminary checks before initiating the actual login flow.

### Method
`uni.preLogin`

### Parameters
#### OBJECT Parameters
- **provider** (string) - Optional - Specifies the login provider.
- **success** (Function) - Optional - Callback function for successful preparation.
- **fail** (Function) - Optional - Callback function for failed preparation.
```

--------------------------------

### GET /cloud-function-url

Source: https://uniapp.dcloud.io/univerify

Invokes a URLized uniCloud cloud function to retrieve a phone number, requiring a HMAC-SHA256 signature for request legitimacy.

```APIDOC
## GET /cloud-function-url

### Description
Invokes a URLized uniCloud cloud function from a traditional server. The request must include an access_token, openid, and a signature generated via HMAC-SHA256 to ensure security.

### Method
GET

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token obtained from the client.
- **openid** (string) - Required - The user's openid.
- **sign** (string) - Required - The HMAC-SHA256 signature of the sorted query parameters.

### Response
#### Success Response (200)
- **data** (object) - Contains the result of the phone number retrieval.
- **data.phoneNumber** (string) - The retrieved phone number.
- **statusCode** (number) - HTTP status code.

#### Response Example
{
	"data": {
		"code": 0,
		"success": true,
		"phoneNumber": "166xxxx6666"
	},
	"statusCode": 200
}
```

--------------------------------

### Import HarmonyOS Next Dependencies

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

Import the necessary checkUpdate utility and upgrade popup component for HarmonyOS Next.

```javascript
import checkUpdate from '@/uni_modules/uni-upgrade-center-app/utils/check-update';
// #ifdef APP-HARMONY
import upgradePopupVue from '@/uni_modules/uni-upgrade-center-app/pages/upgrade-popup.vue';
// #endif
```

--------------------------------

### Configure pages.json for Upgrade Popup

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

Add the upgrade popup page path to your pages.json file. Ensure it is not set as the first page in the array.

```json
"pages": [
		// ……其他页面配置
		{
			"path" : "uni_modules/uni-upgrade-center-app/pages/uni-app-x/upgrade-popup"
		}
	]
```

--------------------------------

### Declare Components and Methods for HarmonyOS

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

Register the upgrade popup component and define a method to trigger the version check.

```javascript
export default {
	// ...
	components: {
		// #ifdef APP-HARMONY
		upgradePopupVue
		// #endif
	},
	methods: {
		checkVersion() {
			// #ifdef APP-PLUS
			checkUpdate()
			// #endif
			// #ifdef APP-HARMONY
			checkUpdate(this.$refs.upgradePopup)
			// #endif
				.then((res) => {
					console.log('res: ', JSON.stringify(res));
				})
				.catch((e) => {
					console.log('e: ', JSON.stringify(e), e);
				});
		}
	}
	// ...
}
```

--------------------------------

### Manage login with univerifyManager

Source: https://uniapp.dcloud.io/univerify

Use the global univerifyManager for more efficient login handling, including pre-login, custom button event subscription, and protocol state checking.

```javascript
const univerifyManager = uni.getUniverifyManager()

// pre-login
univerifyManager.preLogin()

// Call the one-click login popup
univerifyManager.login({
  univerifyStyle: {
    "fullScreen": true,
    "buttons": {
        "iconWidth": "45px",
        "list": [
            {
                "provider": "apple",
                "iconPath": "/static/apple.png"
            },
            {
                "provider": "weixin",
                "iconPath": "/static/wechat.png"
            }
        ]
    }
  },
  success (res) {
    console.log('login success', res)
  }
})

const callback = (res) => {
  // Get the check status of the one-click login popup protocol
  univerifyManager.getCheckBoxState({
    success(res) {
      console.log("getCheckBoxState res: ", res);
      if (res.state) {
        // Close the one-click login popup
        univerifyManager.close()
      }
    }
  })
}
// Subscribe to custom button click event
univerifyManager.onButtonsClick(callback)
// Unsubscribe from custom button click event
univerifyManager.offButtonsClick(callback)
```

--------------------------------

### uni.login

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Initiates the login process for the user. This API is crucial for obtaining user authentication tokens or codes required for backend verification.

```APIDOC
## uni.login(OBJECT)

### Description
Initiates the login process for the user. This API is crucial for obtaining user authentication tokens or codes required for backend verification.

### Method
`uni.login`

### Parameters
#### OBJECT Parameters
- **provider** (string) - Optional - Specifies the login provider (e.g., 'weixin', 'baidu'). If not specified, the default provider is used.
- **success** (Function) - Optional - Callback function for successful login.
- **fail** (Function) - Optional - Callback function for failed login.

### Notes
- Compatibility varies across App, Mini Programs, and Web platforms.
- Refer to platform-specific documentation for details on supported login methods.
```

--------------------------------

### Pre-login Check for One-Click Login

Source: https://uniapp.dcloud.io/univerify

Use `uni.preLogin` to determine if the device supports one-click login and to prepare the environment. This function may fail if a valid SIM card is not inserted or cellular data is off. HarmonyOS does not support this method.

```javascript
uni.preLogin({
	provider: 'univerify',
	success(){
		// Display one-click login options
	},
	fail(res){
		// Don't show the one-click login option (or grey it out)
    // Determine the cause of the failure according to the error message, and submit the error to the statistics server if necessary
		console.log(res.errCode)
		console.log(res.errMsg)
	}
})

```

--------------------------------

### Enable Full Screen Mode for One-Click Login

Source: https://uniapp.dcloud.io/univerify

Configures the login interface to display in full-screen mode by setting the fullScreen property within univerifyStyle. Note that this is not supported on HarmonyOS.

```javascript
uni.login({
	provider: 'univerify',
	univerifyStyle: {
    fullScreen: true
  }
})
```

--------------------------------

### uni.preLogin(OBJECT)

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Performs a pre-login operation, specifically used for one-click login with an App phone number.

```APIDOC
## uni.preLogin(OBJECT)

### Description
Pre-login. It is used for one-click login with App phone number.

### Method
uni.preLogin

### Parameters
#### Request Body
- **provider** (String) - Optional - Login service provider, obtained through uni.getProvider
- **success** (Function) - Optional - Callback for successful interface call
- **fail** (Function) - Optional - Callback function for interface call failure
- **complete** (Function) - Optional - Callback function for the end of the interface call
```

--------------------------------

### Import checkUpdate Method

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

Import the checkUpdate utility function at the top of your script tag.

```javascript
import checkUpdate from '@/uni_modules/uni-upgrade-center-app/utils/check-update'
```

--------------------------------

### uni.login

Source: https://uniapp.dcloud.io/univerify

Triggers the user authorization interface to obtain an access token for one-click login.

```APIDOC
## uni.login

### Description
Displays the user authorization interface. Returns the corresponding callback based on user operation and authorization result, providing an access_token.

### Method
uni.login(options)

### Parameters
#### Request Body
- **provider** (string) - Required - Must be 'univerify'
- **univerifyStyle** (object) - Optional - Configuration for customizing the login interface appearance.
- **success** (function) - Optional - Callback on success
- **fail** (function) - Optional - Callback on failure

### Request Example
```
uni.login({
	provider: 'univerify',
	univerifyStyle: {},
	success(res){}
})
```

### Response
#### Success Response (200)
- **errMsg** (string) - Status message
- **authResult** (object) - Contains openid and access_token

#### Response Example
```
{
	"errMsg": "login:ok",
	"authResult": {
		"openid": "...",
		"access_token": "..."
	}
}
```
```

--------------------------------

### Check for One-Click Login Provider Availability

Source: https://uniapp.dcloud.io/univerify

Verifies if the one-click login service is available in the current environment by checking the provider list for 'univerify'. This is not supported on HarmonyOS.

```javascript
uni.getProvider({
  service: 'oauth',
  success: function (res) {
    console.log(res.provider)// ['qq', 'univerify']
  }
});
```

--------------------------------

### Handle custom button click response

Source: https://uniapp.dcloud.io/univerify

The data structure returned when a user clicks a custom button configured in univerifyStyle.

```json
{
  "code": "30008",
  "errMsg": "用户点击了自定义按钮",
  "provider": "apple",
}
```

--------------------------------

### uni.getUniverifyManager(OBJECT)

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieves the globally unique one-click login manager instance.

```APIDOC
## uni.getUniverifyManager(OBJECT)

### Description
Get the globally unique one-click login manager univerifyManager.

### Methods
- **login** (Function) - One-key login
- **preLogin** (Function) - One-key login pre-login
- **close** (Function) - Close one-click landing page
- **getCheckBoxState** (Function) - Get one-click login terms checkbox state
- **onButtonsClick** (Function) - Subscribe to one-click login custom button click event
- **offButtonsClick** (Function) - Unsubscribe from one-click login custom button click event

### Request Example
```javascript
const univerifyManager = uni.getUniverifyManager()
univerifyManager.login({
  univerifyStyle: {
    "fullScreen": true
  },
  success (res) {
    console.log('login success', res)
  }
})
```
```

--------------------------------

### UniApp Univerify Style Configuration

Source: https://uniapp.dcloud.io/univerify

Defines the structure for customizing the appearance and behavior of the uni one-click login authorization interface. HarmonyOS has specific supported properties for this configuration.

```json
{
    "fullScreen": false, 
    "backgroundColor": "#ffffff",  
    "icon": {
        "path": "static/xxx.png", 
        "width":  "60px",  
    },
    "closeIcon": {
        "path": "static/xxx.png", 
        "width":  "60px",  
    },
    "phoneNum": {
    },
    "slogan": {
    },
    "authButton": {
        "normalColor": "#3479f5", 
        "highlightColor": "#2861c5",  
        "disabledColor": "#73aaf5",  
        "textColor": "#ffffff",  
        "title": "本机号码一键登录", 
    },
    "otherLoginButton": {
        "visible": true, 
        "normalColor": "", 
        "highlightColor": "", 
        "textColor": "#656565", 
        "title": "其他登录方式", 
        "borderColor": "",  
    },
    "privacyTerms": {
        "defaultCheckBoxState":true, 
        "isCenterHint":false, 
        "uncheckedImage":"", 
        "checkedImage":"", 
        "checkBoxSize":12, 
        "textColor": "#BBBBBB", 
        "termsColor": "#5496E3", 
        "prefix": "我已阅读并同意", 
        "suffix": "并使用本机号码登录",
            {
                "url": "https://", 
            }
        ]
    },
    "buttons": {
        "list": [
            {
                "provider": "apple",
            },
            {
                "provider": "weixin",
            }
        ]
    }
}

```

--------------------------------

### uni.getUserInfo

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieve user profile information from the service provider.

```APIDOC
## uni.getUserInfo

### Description
Get user information. Note that usage rules for avatars and nicknames have been adjusted on several platforms.

### Parameters
#### Request Body
- **provider** (String) - Optional - Login service provider
- **withCredentials** (Boolean) - Optional - Whether to include login status information
- **lang** (String) - Optional - Language for returning user information (zh_CN, zh_TW, en)
- **timeout** (Number) - Optional - Timeout time in ms
- **success** (Function) - Optional - Success callback
- **fail** (Function) - Optional - Failure callback
- **complete** (Function) - Optional - Completion callback

### Response
#### Success Response (200)
- **userInfo** (OBJECT) - User information object
- **rawData** (String) - Raw data string without sensitive info
- **signature** (String) - Signature for verification
- **encryptedData** (String) - Encrypted user information
- **iv** (String) - Initialization vector for decryption
- **errMsg** (String) - Error message
```

--------------------------------

### Request Login Authorization with UniApp

Source: https://uniapp.dcloud.io/univerify

Initiates the user authorization interface for one-click login. HarmonyOS does not support `uni.login` for one-click login and requires `univerifyManager`. The `univerifyStyle` object allows for customization of the login interface.

```javascript
uni.login({
	provider: 'univerify',
	univerifyStyle: {
		// Refer to `univerifyStyle data structure`
  },
	success(res) {
	},
	fail(res){
		console.log(res.errCode)
		console.log(res.errMsg)
	}
})

```

--------------------------------

### Uni-request POST to Cloud Function and Received Event

Source: https://uniapp.dcloud.io/uniCloud/http

Demonstrates making a POST request using uni.request to a cloud function and the structure of the event object received by the function, including the body.

```javascript
// 以uni.request为例
uni.request({
  method: 'POST',
  url: 'https://${云函数Url化域名}/${functionPath}',
  data: {
    a: 1,
    b: 2
  },
  success(res) {
    console.log(res);
  }
})

// 云函数收到的event为, 注意如果直接return此格式数据可能会被作为集成响应处理，参考下面的集成响应文档
{
    path: '/',
    httpMethod: 'POST',
    headers: {
    	...
    	"content-type": 'application/json'
    },
    isBase64Encoded: false,
    body: '{"a":1,"b":2}', // 注意此处可能是base64，需要根据isBase64Encoded判断
}
```

--------------------------------

### 云函数处理 Base64 编码的请求体

Source: https://uniapp.dcloud.io/uniCloud/http

在云函数中检查`event.isBase64Encoded`，如果为true，则将`event.body`从Base64解码为UTF-8字符串。

```javascript
// 云函数
exports.main = function(event) {
    let body = event.body
    if(event.isBase64Encoded){
        body = Buffer.from(body, 'base64').toString('utf8') // 将base64格式的xml内容转为xml字符串
    }
}

```

--------------------------------

### uni.getLoginCode

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Obtain the host App login credentials (Authorization Code) for server-side authentication.

```APIDOC
## uni.getLoginCode

### Description
Obtain the host App login credentials (Authorization Code). The developer needs to call the API in the background of the developer server to exchange the code for session_key and other information.

### Parameters
#### Request Body
- **timeout** (Number) - Optional - Timeout (unit: ms)
- **success** (Function) - Optional - Callback function for successful interface call
- **fail** (Function) - Optional - Callback function for interface call failure
- **complete** (Function) - Optional - The callback function for the end of the interface call

### Response
#### Success Response (200)
- **code** (String) - User login credentials (valid for ten minutes).
```

--------------------------------

### uni.closeAuthView()

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Closes the one-key login page as required by mobile operators.

```APIDOC
## uni.closeAuthView()

### Description
Closes the one-key login page. According to the requirements of China Mobile, China Unicom, China Telecom and other operators, one-click login must have an interface. Use this API to close the page.

### Method
Function

### Endpoint
uni.closeAuthView()
```

--------------------------------

### Trigger Update Check in Template

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

Add a button to the template to trigger the version check and include the upgrade popup component.

```html
<template>
	<!-- 页面其他内容... -->
	<button @click="checkVersion">检查升级</button>
	<!-- #ifdef APP-HARMONY -->
	<upgradePopupVue ref="upgradePopup" @show="upgradePopupShow" @close="upgradePopupClose" />
	<!-- #endif -->
</template>
```

--------------------------------

### 计算云数据库读操作费用

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

根据云函数调用次数推算云数据库的读操作计费。

```text
读操作次数费用 = 读操作次数（万次） * 0.015
			= 云函数调用次数（万次） * 0.015
			= App日活 * 每日活用户平均每天启动App次数 / 10000 * 0.015
			= 100 * 2 / 10000 * 0.015
			= 0.0003
```

--------------------------------

### 云对象处理 Base64 编码的请求体

Source: https://uniapp.dcloud.io/uniCloud/http

在云对象中检查`httpInfo.isBase64Encoded`，如果为true，则将`httpInfo.body`从Base64解码为UTF-8字符串。

```javascript
// 云对象
module.exports = {
    addTodo: function() {
        let httpInfo = this.getHttpInfo()
        let body = httpInfo.body
        if(httpInfo.isBase64Encoded){
            body = Buffer.from(body, 'base64').toString('utf8') // 将base64格式的xml内容转为xml字符串
        }
    }
}

```

--------------------------------

### uni.getCheckBoxState(OBJECT)

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieves the checkbox status of the one-key login clause.

```APIDOC
## uni.getCheckBoxState(OBJECT)

### Description
Get the checkbox status of one-key login clause.

### Parameters
#### OBJECT parameter description
- **success** (Function) - Optional - Callback for successful interface call
- **fail** (Function) - Optional - Callback function for interface call failure
- **complete** (Function) - Optional - The callback function for the end of the interface call

### Response
#### Success Response (200)
- **state** (Boolean) - One-click login terms checkbox state
- **errMsg** (String) - Description
```

--------------------------------

### uni.getUniverifyManager

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Obtains a manager object for Univerify, a service that simplifies phone number-based login across different platforms.

```APIDOC
## uni.getUniverifyManager(OBJECT)

### Description
Obtains a manager object for Univerify, a service that simplifies phone number-based login across different platforms.

### Method
`uni.getUniverifyManager`

### Parameters
#### OBJECT Parameters
- **success** (Function) - Optional - Callback function that receives the UniverifyManager instance.
- **fail** (Function) - Optional - Callback function for failure.

### Notes
- For HarmonyOS, specific considerations apply when using `getUniverifyManager`.
```

--------------------------------

### uni.login API

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

The uni.login API is a client-side interface that unifies and encapsulates various common login methods across different platforms, including one-click mobile number login, third-party logins (WeChat, Weibo, QQ, Apple, Google, Facebook), and MiniApp built-in logins.

```APIDOC
## uni.login(OBJECT)

### Description
Logs the user in using a unified interface for various platform-specific login methods.

### Method
`uni.login`

### Parameters
#### Request Body
- **provider** (String) - Optional - Login service provider, obtained through `uni.getProvider`. If not set, a login list selection interface will pop up.
- **scopes** (String/Array) - Conditional - Authorization type, defaults to `auth_base`. Supports `auth_base` (silent authorization), `auth_user` (active authorization), `auth_zhima` (Zhima Credit). Specific to Alipay MiniApp.
- **timeout** (Number) - Optional - Timeout duration in milliseconds. Supported on WeChat MiniApp, Baidu MiniApp, JD MiniApp, and Xiaohongshu MiniApp.
- **univerifyStyle** (Object) - Optional - Style configuration for the one-click login page. Supported on App 3.0.0+ and HarmonyOS (not supported).
- **onlyAuthorize** (Boolean) - Optional - For WeChat login, requests only authorization authentication. Supported on App 3.2.6+ and HarmonyOS (not supported).
- **success** (Function) - Optional - Callback function executed when the interface call is successful.
- **fail** (Function) - Optional - Callback function executed when the interface call fails.
- **complete** (Function) - Optional - Callback function executed when the interface call completes, regardless of success or failure.

### Request Example
```javascript
uni.login({
  success: function (loginRes) {
    console.log(loginRes.authResult);
  }
});
```

### Response
#### Success Response (200)
- **authResult** (Object) - The login information provided by the login service provider. The returned results vary between different providers. For WeChat login with `onlyAuthorize: true`, this item is empty (App 3.2.6+).
- **code** (String) - User login credential. Developers need to use this code on their backend server to exchange for `openid`, `session_key`, and other information. Returned for WeChat login with `onlyAuthorize: true` (App 3.2.6+), and JD MiniApp.
- **appleInfo** (Object) - Information returned for Apple login. Supported on App 3.4.3+.
- **errMsg** (String) - Description of the operation result.

#### Response Example
```json
{
  "authResult": {},
  "code": "USER_CODE_FROM_WECHAT",
  "errMsg": "login:ok"
}
```

### Notes
- For Baidu MiniApp, `uni.login` should be called after the `@login` event of the `button` component. Otherwise, a "Please log in" error may occur. It is recommended to call it within the `@login` event.
- `uni.login` has been upgraded for Baidu MiniApp compatibility and now uses `getLoginCode`. However, in some cases, compatibility diagnostics may still indicate `swan.login` as non-compliant. `uni.getLoginCode` can be used as an alternative.
- The JD MiniApp IDE currently does not support `uni.login()`. Testing on a real device is recommended. IDE calls may only return simulated data with a status code of 200.
```

--------------------------------

### uni.getUserInfo

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieves basic user information. Note that this API might be deprecated or have privacy restrictions depending on the platform and uni-app version.

```APIDOC
## uni.getUserInfo(OBJECT)

### Description
Retrieves basic user information. Note that this API might be deprecated or have privacy restrictions depending on the platform and uni-app version.

### Method
`uni.getUserInfo`

### Parameters
#### OBJECT Parameters
- **provider** (string) - Optional - Specifies the user info provider.
- **success** (Function) - Optional - Callback function for successful retrieval of user info.
- **fail** (Function) - Optional - Callback function for failed retrieval.

### Notes
- Compatibility and availability may vary.
- For App platforms, refer to extended login documentation for specific SDK integrations.
```

--------------------------------

### Configure HarmonyOS Network Permissions

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Required permissions configuration for HarmonyOS applications to access network and authentication services.

```json
"requestPermissions": [
  {
    //允许应用程序联网，用于访问网关和认证服务器
    "name": "ohos.permission.INTERNET",
  },
  {
    //获取网络状态，判断是否数据、wifi等
    "name": "ohos.permission.GET_NETWORK_INFO"
  },
  {
    //允许获取wifi信息
    "name": "ohos.permission.GET_WIFI_INFO"
  },
  {
    //允许应用配置数据网络
    "name": "ohos.permission.SET_NETWORK_INFO"
  },
  {
    //用于创建唯一的gyuid标识
    "name": "ohos.permission.APP_TRACKING_CONSENT",
    "usedScene": {
      "abilities": [
        "EntryAbility"
      ]
    },
  }
]
```

--------------------------------

### uni.getCheckBoxState

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieves the state of a checkbox, likely related to user agreement or privacy consent during the login process.

```APIDOC
## uni.getCheckBoxState(OBJECT)

### Description
Retrieves the state of a checkbox, likely related to user agreement or privacy consent during the login process.

### Method
`uni.getCheckBoxState`

### Parameters
#### OBJECT Parameters
- **success** (Function) - Optional - Callback function with the checkbox state.
- **fail** (Function) - Optional - Callback function for failure.
```

--------------------------------

### 云数据库费用汇总公式

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

总结云数据库总费用的构成，指出读操作为主要计费项。

```text
云数据库费用 = 容量费（忽略为0） + 读操作费用 + 写操作费用（忽略为0）
		   = 读操作费用
```

--------------------------------

### 普通云函数处理 Cookie

Source: https://uniapp.dcloud.io/uniCloud/http

在普通云函数中引入cookie库来解析请求中的cookie，并设置响应头中的`set-cookie`。

```javascript
'use strict';
//引入cookie
const cookie = require('cookie')
exports.main = async (event, context) => {
	const cookieData = cookie.parse(event.headers.cookie || '')
	//设置cookie到客户端
	const cookieOptions = {
		//具体参数请查阅 https://www.npmjs.com/package/cookie
		maxAge: 60 * 60 * 24 * 7,//一周
		path:"/"
	}
	const setCookieData = cookie.serialize('app', 'appName', cookieOptions)
	return {
		statusCode: 200,
		headers: {
				'content-type': '返回数据类型',
				'set-cookie': setCookieData // 在headers内返回set-cookie用于设置客户端cookie
		},
		body: '返回数据'
	}
};

```

--------------------------------

### Implement checkUpdate in Lifecycle

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

Execute the checkUpdate method within a lifecycle hook like onReady to trigger the update check.

```javascript
import checkUpdate from '@/uni_modules/uni-upgrade-center-app/utils/check-update'
// ...
export default {
	// ...
	onReady() {
		checkUpdate()
	}
	// ...
}
```

--------------------------------

### uni.getLoginCode

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieves the login code for the user, which can be exchanged for a session token on the server-side. This is commonly used in mini-program environments.

```APIDOC
## uni.getLoginCode(OBJECT)

### Description
Retrieves the login code for the user, which can be exchanged for a session token on the server-side. This is commonly used in mini-program environments.

### Method
`uni.getLoginCode`

### Parameters
#### OBJECT Parameters
- **success** (Function) - Optional - Callback function for successful retrieval of the login code.
- **fail** (Function) - Optional - Callback function for failed retrieval.

### Notes
- Primarily used in mini-program contexts.
```

--------------------------------

### 云对象处理 Cookie

Source: https://uniapp.dcloud.io/uniCloud/http

在云对象中引入cookie库来解析`getHttpInfo()`获取的cookie，并设置响应头中的`set-cookie`。

```javascript
'use strict';
//引入cookie
const cookie = require('cookie')
module.exports = {
  addTodo: function () {
    const httpInfo = this.getHttpInfo()
    const cookieData = cookie.parse(httpInfo.headers.cookie || '')
    //设置cookie到客户端
    const cookieOptions = {
    	//具体参数请查阅 https://www.npmjs.com/package/cookie
    	maxAge: 60 * 60 * 24 * 7,//一周
    	path:"/"
    }
    const setCookieData = cookie.serialize('app', 'appName', cookieOptions)
    return {
    	statusCode: 200,
    	headers: {
    			'content-type': '返回数据类型',
    			'set-cookie': setCookieData // 在headers内返回set-cookie用于设置客户端cookie
    	},
    	body: '返回数据'
    }
  }
};

```

--------------------------------

### Expose Cloud Function as HTTP Interface for 5+ (wap2app)

Source: https://uniapp.dcloud.io/univerify

For 5+ (wap2app) projects, cloud functions can be URLized to expose them as standard HTTP interfaces. Client code then uses standard AJAX requests. Ensure the client sends requests with 'Content-Type: application/json' if the cloud function expects a JSON body.

```javascript
const xhr = new plus.net.XMLHttpRequest();
xhr.onload = function(e) {
  const { 
    code,
    message 
  } = JSON.parse(xhr.responseText)
}
xhr.setRequestHeader('Content-Type','application/json');
xhr.send(JSON.stringify({
  access_token: 'xxx', // 客户端一键登录接口返回的access_token
}));
```

```javascript
// The following only shows the scenario where the client sends a request with a content-type of application/json using the post method
exports.main = async(event) => {
  let body = event.body
  if(event.isBase64Encoded) {
    body = Buffer.from(body,'base64')
  }
  const { 
    access_token,
    openid 
  } = JSON.parse(body)
  const res = await uniCloud.getPhoneNumber({
  	provider: 'univerify',
  	access_token: access_token,
  	openid: openid
  })
  console.log(res); // res里包含手机号
  // 如果数据库不在uniCloud上，可以通过 uniCloud.httpclient API，将手机号通过http方式传递给其他服务器的接口，详见：https://doc.dcloud.net.cn/uniCloud/cf-functions?id=httpclient

    code: 0,
  }
}
```

--------------------------------

### Call UniCloud Cloud Function from uni-app

Source: https://uniapp.dcloud.io/univerify

Use uniCloud.callFunction to invoke cloud functions from an uni-app client. Ensure the uni-app project has a uniCloud development environment set up and bound to a service space.

```javascript
// After getting access_token, call cloud function through callfunction
uniCloud.callFunction({
  data: {
    'access_token': 'xxx', // 客户端一键登录接口返回的access_token
  }
}).then(res => {
  // res.result = {
  //   code: '',
  //   message: ''
  // }
  // The login is successful, you can close the one-click login authorization interface
}).catch(err=>{
  // handle errors
})
```

```javascript
'use strict';
exports.main = async (event, context) => {
  // event contains the parameters submitted by the client
  const res = await uniCloud.getPhoneNumber({
  	provider: 'univerify',
  	access_token: event.access_token,
  	openid: event.openid
  })

  console.log(res); // res里包含手机号
  // Perform operations such as user information storage. Under normal circumstances, do not return the full mobile phone number to the front end
  // 如果数据库在uniCloud上，可以直接入库
  // 如果数据库不在uniCloud上，可以通过 uniCloud.httpclient API，将手机号通过http方式传递给其他服务器的接口，详见：https://doc.dcloud.net.cn/uniCloud/cf-functions?id=httpclient
  return {
    code: 0,
  }
}
```

--------------------------------

### uni.closeAuthView

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Closes any currently displayed authentication or login view/modal.

```APIDOC
## uni.closeAuthView()

### Description
Closes any currently displayed authentication or login view/modal.

### Method
`uni.closeAuthView`

### Parameters
None
```

--------------------------------

### 计算云函数每日费用

Source: https://uniapp.dcloud.io/uniCloud/upgrade-center

基于资源使用量、调用次数和出网流量计算云函数每日成本。

```text
云函数费用（天） = 资源使用量 * 0.000110592  + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8
			  = 云函数内存（单位为G） * 云函数平均单次执行时长（单位为秒） * 调用次数 + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8
			  = 0.25G * 0.1S * 100 * 2 * 0.000110592 + 100 * 2 * 0.0133/10000 + 0
			  = 0.00081896（元）
```

--------------------------------

### HTTP Response for String Return

Source: https://uniapp.dcloud.io/uniCloud/http

The resulting HTTP response when a cloud function returns a plain string. Includes status, headers, and the body content.

```http
HTTP/1.1 200 OK
date: Mon, 16 Dec 2019 08:35:31 GMT
content-type: text/plain; charset=utf-8
content-length: 13

hello gateway
```

--------------------------------

### Generate Signature for uniCloud Request (Node.js)

Source: https://uniapp.dcloud.io/univerify

Use this Node.js code to generate a signature for requests to your URLized uniCloud cloud functions. Ensure parameters are sorted alphabetically before signing.

```javascript
const crypto = require('crypto')

const hmac = crypto.createHmac('sha256', secret);

// Generate signature by own server and send request in GET mode
const params = {
  openid: 'xxx'
}
// Concatenate the signature string after sorting alphabetically
const signStr = Object.keys(params).sort().map(key => {
  return `${key}=${params[key]}`
}).join('&')
hmac.update(signStr);
const sign = hmac.digest('hex')
// The final request is as follows, where https://xxxx/xxx is the URL of the cloud function
// https://xxxx/xxx?access_token=xxx&openid=xxx&sign=${sign} where ${sign} is the sign value obtained in the previous step

```

--------------------------------

### uni.getUserProfile(OBJECT)

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Retrieves user information. Note that this interface has been withdrawn in newer WeChat MiniApp versions and requires user authorization via a pop-up window.

```APIDOC
## uni.getUserProfile(OBJECT)

### Description
Get user information. An authorization window will pop up for each request, and userInfo will be returned after the user agrees.

### Method
uni.getUserProfile

### Parameters
#### Request Body
- **desc** (String) - Required - Describe the purpose of obtaining the user's personal information, no more than 30 characters
- **lang** (String) - Optional - Specifies the language for returning user information (en, zh_CN, zh_TW)
- **success** (Function) - Optional - Callback for successful interface call
- **fail** (Function) - Optional - Callback function for interface call failure
- **complete** (Function) - Optional - Callback function for the end of the interface call

### Response
#### Success Response (200)
- **userInfo** (OBJECT) - User information object (nickName, avatarUrl, gender, country, province, city, language)
- **rawData** (String) - The raw data string excluding sensitive information
- **signature** (String) - String for verifying user information
- **encryptedData** (String) - Encrypted data of complete user information
- **iv** (String) - Initial vector of encryption algorithm
- **cloudID** (String) - Cloud ID for sensitive data
- **errMsg** (String) - Description
```

--------------------------------

### Cloud Function Returning a String

Source: https://uniapp.dcloud.io/uniCloud/http

A simple cloud function that returns a string. The HTTP response will have a 'text/plain' content type.

```javascript
exports.main = function() {
    return 'hello gateway'
}
```

--------------------------------

### uni.checkSession

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Check if the current user login status has expired.

```APIDOC
## uni.checkSession

### Description
Check if the login status has expired.

### Parameters
#### Request Body
- **success** (Function) - Optional - Callback function for successful interface call
- **fail** (Function) - Optional - Callback function for interface call failure
- **complete** (Function) - Optional - The callback function for the end of the interface call
```

--------------------------------

### uni.checkSession

Source: https://uniapp.dcloud.io/api/plugins/login?id=getuniverifymanager

Checks the validity of the current user session. This API helps determine if the user is still logged in without requiring them to re-authenticate.

```APIDOC
## uni.checkSession()

### Description
Checks the validity of the current user session. This API helps determine if the user is still logged in without requiring them to re-authenticate.

### Method
`uni.checkSession`

### Parameters
None

### Response
#### Success Response
- **errMsg** (string) - Indicates the session is valid.

#### Error Response
- **errMsg** (string) - Indicates the session is invalid or has expired.
```
Tokens:
Raw