Module "user"

微信公众号(小程序)登录服务端接口，官方文档

Index

Interfaces

Functions

Functions

Const checkAccessToken

checkAccessToken(accessToken: string, openID: string): Promise<boolean | ICheckAccessToken>

- Defined in user.ts:176
检验用户的accesstoken是否过期

Parameters
- accessToken: string
  
  用户accesstoken
- openID: string
  
  用户openid
Returns Promise<boolean | ICheckAccessToken>

Const code2AccessToken

code2AccessToken(appId: string, appsecret: string, code: string): Promise<IAccessTokenResp | null>

- Defined in user.ts:34
公众号登录通过code换取用户的accessToken 如果errcode存在，那么不会返回access_token
```
const {code2AccessToken} from 'ts-wxsdk/user'
const tokenInfo = await code2AccessToken(appid,appsecret,code)
```
Parameters
- appId: string
- appsecret: string
- code: string
Returns Promise<IAccessTokenResp | null>

Const code2Session

code2Session(appid: string, secret: string, js_code: string, grant_type?: string): Promise<ICode2Session | null>

- Defined in user.ts:69
小程序登录根据code获取用户的session_key和openid
```
const {code2Session} from 'ts-wxsdk/user'
const session = await code2Session(appid,secrect,code);
```
Parameters
- appid: string
- secret: string
  
  小程序 appSecret
- js_code: string
  
  登录时获取的 code
- Default value grant_type: string = "authorization_code"
  
  授权类型，此处只需填写 authorization_code
Returns Promise<ICode2Session | null>

Const code2userinfo

code2userinfo(appId: string, secret: string, code: string): Promise<IUserinfo | null>

- Defined in user.ts:158
公众号号登录，通过code一步换取userinfo。

Parameters
- appId: string
  
  appid
- secret: string
  
  appsecret
- code: string
  
  code
Returns Promise<IUserinfo | null>

Const refreshAccessToken

refreshAccessToken(appId: string, refreshToken: string): Promise<IAccessTokenResp | null>

- Defined in user.ts:98
由于access_token拥有较短的有效期，当access_token超时后，可以使用refresh_token进行刷新，refresh_token有效期为30天，当refresh_token失效之后，需要用户重新授权。

Parameters
- appId: string
- refreshToken: string
Returns Promise<IAccessTokenResp | null>

Const userinfo

userinfo(accessToken: string, openID: string, lang?: string): Promise<IUserinfo | null>

- Defined in user.ts:137
公众号适用。通过用户的accesstoken和openID获取用户的基本信息拉取用户信息(需scope为 snsapi_userinfo)

Parameters
- accessToken: string
  
  用户的accessToken，注意：这个accessToken和基础的accessToken不是同一个。
- openID: string
  
  用户openid
- Default value lang: string = "zh_CN"
  
  语言，默认'zh_CN'
Returns Promise<IUserinfo | null>

Const userlist

userlist(accessToken: string, nextOpenID?: string): Promise<IUserlist | null>

- Defined in user.ts:202
Parameters
- accessToken: string
  
  基础平台accessToken
- Default value nextOpenID: string = ""
  
  分页的下一步.
Returns Promise<IUserlist | null>

Generated using TypeDoc