微信小程序云開發(fā)服務(wù)端API 工具類

2022-05-12 16:13 更新

工具類 API

云開發(fā)提供了一系列工具類的 API,此處是存儲小程序端的 API 參考文檔。

API 說明
getWXContext 獲取微信上下文


getWXContext

在云函數(shù)中獲取微信調(diào)用上下文,該方法無需傳入?yún)?shù),會返回以下字段:

字段含義字段存在條件最低版本
OPENID小程序用戶 openid小程序端調(diào)用云函數(shù)時
APPID小程序 AppID小程序端調(diào)用云函數(shù)時
UNIONID小程序用戶 unionid小程序端調(diào)用云函數(shù),并且滿足 unionid 獲取條件
ENV云函數(shù)所在環(huán)境的 ID0.6.0
SOURCE調(diào)用來源(云函數(shù)本次運行是被什么觸發(fā))0.7.0

SOURCE 值跟隨調(diào)用鏈條傳遞,會表示調(diào)用鏈路情況(用英文逗號分隔),比如小程序調(diào)用云函數(shù) A,再在云函數(shù) A 內(nèi)調(diào)用云函數(shù) B,則 A 獲得的 SOURCE 為 wx_client, B 內(nèi)獲得的 SOURCE 為 wx_client,scf(微信小程序調(diào)用,然后云函數(shù)調(diào)用)。

SOURCE 的枚舉類型:

SOURCE 值含義
wx_devtools微信 IDE 調(diào)用
wx_client微信小程序調(diào)用
wx_http微信 HTTP API 調(diào)用
wx_unknown微信未知來源調(diào)用
scf云函數(shù)調(diào)用云函數(shù)
其他非微信端觸發(fā)

如果在云函數(shù)本地調(diào)試中,ENV 會為 local,SOURCE 會為 wx_client。

注意事項

請不要在 exports.main 外使用 getWXContext,此時尚沒有調(diào)用上下文,無法獲取得到信息。

使用示例

const cloud = require('wx-server-sdk')

exports.main = async (event, context) => {
  const {
    OPENID,
    APPID,
    UNIONID,
    ENV,
  } = cloud.getWXContext()

  return {
    OPENID,
    APPID,
    UNIONID,
    ENV,
  }
}


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號