miniapp

Documentation

Index

• type CodeGenArg
• type OptionFunc
  • func WithTokenServer(uri string) OptionFunc
• type TmplData
  • func NewTmplData(openid, templateid, formid string) *TmplData
  • func (t *TmplData) Link(page string)
  • func (t *TmplData) Put(key, value, color string)
• type WXAppSession
• type WXMiniClient
  • func NewClient(appid, secret string, options ...OptionFunc) *WXMiniClient
  • func (c *WXMiniClient) AppID() string
  • func (c *WXMiniClient) GetPhoneNumber(iv, cipherTxt, sessionKey string) (WXPhoneInfo, error)
  • func (c *WXMiniClient) GetSessionKey(code string) (WXAppSession, error)
  • func (c *WXMiniClient) GetUserInfo(iv, cipherTxt, sessionKey string) (WXUserInfo, error)
  • func (c *WXMiniClient) SendWXAppTemplate(data *TmplData) error
  • func (c *WXMiniClient) WXACode_A(arg CodeGenArg) (io.Reader, error)
  • func (c *WXMiniClient) WXACode_B(arg CodeGenArg) (io.Reader, error)
  • func (c *WXMiniClient) WXACode_C(arg CodeGenArg) (io.Reader, error)
  • func (c *WXMiniClient) WXAppDecript(crypted, sessionkey, iv string) ([]byte, error)
  • func (c *WXMiniClient) WXAppSign(rawdata, sessionkey string) string
• type WXPhoneInfo
• type WXSexType
  • func (t WXSexType) String() string
• type WXUserInfo

Types

type CodeGenArg

type CodeGenArg struct {
	Sence     string `json:"scene"`
	Path      string `json:"path"`
	Width     int    `json:"width"`
	AutoColor bool   `json:"auto_color"`
	LineColor struct {
		R string `json:"r"`
		G string `json:"g"`
		B string `json:"b"`
	} `json:"line_color"`
}

CodeGenArg 小程序码生成参数

type OptionFunc

type OptionFunc func(*WXMiniClient)

OptionFunc 配置函数

func WithTokenServer

func WithTokenServer(uri string) OptionFunc

WithTokenServer 设置Token server

type TmplData

type TmplData struct {
	ToUser       string `json:"touser"`
	WeAppTmplMsg struct {
		TemplateID string                   `json:"template_id"`
		Page       string                   `json:"page"`
		FormID     string                   `json:"form_id"`          // Prepayid or form id
		Keyword    string                   `json:"emphasis_keyword"` // 模板需要放大的关键词，不填则默认无放大
		Data       map[string]tmplFieldData `json:"data"`
		FontColor  string                   `json:"color"` // 模板内容字体的颜色，不填默认黑色
	} `json:"weapp_template_msg"`
}

TmplData 微信小程序模板消息

func NewTmplData

func NewTmplData(openid, templateid, formid string) *TmplData

NewTmplData 创建模板

func (*TmplData) Link

func (t *TmplData) Link(page string)

Link 设置跳转页

func (*TmplData) Put

func (t *TmplData) Put(key, value, color string)

Put 追加数据项

type WXAppSession

type WXAppSession struct {
	ErrCode    int
	ErrMsg     string
	OpenID     string
	SessionKey string `json:"session_key"`
}

WXAppSession 微信小程序会话

type WXMiniClient

type WXMiniClient struct {
	// contains filtered or unexported fields
}

WXMiniClient 微信小程序客户端

func NewClient

func NewClient(appid, secret string, options ...OptionFunc) *WXMiniClient

NewClient 创建客户端

func (*WXMiniClient) AppID

func (c *WXMiniClient) AppID() string

AppID 返回当前小程序APP ID

func (*WXMiniClient) GetPhoneNumber

func (c *WXMiniClient) GetPhoneNumber(iv, cipherTxt, sessionKey string) (WXPhoneInfo, error)

GetPhoneNumber 获取微信绑定电话号码

func (*WXMiniClient) GetSessionKey

func (c *WXMiniClient) GetSessionKey(code string) (WXAppSession, error)

GetSessionKey 获取小程序session key

func (*WXMiniClient) GetUserInfo

func (c *WXMiniClient) GetUserInfo(iv, cipherTxt, sessionKey string) (WXUserInfo, error)

GetUserInfo 获取微信用户信息

func (*WXMiniClient) SendWXAppTemplate

func (c *WXMiniClient) SendWXAppTemplate(data *TmplData) error

SendWXAppTemplate 发送微信小程序模板

func (*WXMiniClient) WXACode_A

func (c *WXMiniClient) WXACode_A(arg CodeGenArg) (io.Reader, error)

WXACode_A 适用于需要的码数量较少的业务场景 通过该接口生成的小程序码，永久有效，数量限制见文末说明，请谨慎使用。 用户扫描该码进入小程序后，将直接进入 path 对应的页面

func (*WXMiniClient) WXACode_B

func (c *WXMiniClient) WXACode_B(arg CodeGenArg) (io.Reader, error)

WXACode_B 适用于需要的码数量极多，或仅临时使用的业务场景 通过该接口生成的小程序码，永久有效，数量暂无限制。用户扫描该码进入小程序后， 开发者需在对应页面获取的码中 scene 字段的值，再做处理逻辑。 使用如下代码可以获取到二维码中的 scene 字段的值。 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟， 开发工具模拟时的 scene 的参数值需要进行 urlencode

func (*WXMiniClient) WXACode_C

func (c *WXMiniClient) WXACode_C(arg CodeGenArg) (io.Reader, error)

WXACode_C 适用于需要的码数量较少的业务场景 通过该接口生成的小程序二维码，永久有效，数量限制见文末说明，请谨慎使用。 用户扫描该码进入小程序后，将直接进入 path 对应的页面

func (*WXMiniClient) WXAppDecript

func (c *WXMiniClient) WXAppDecript(crypted, sessionkey, iv string) ([]byte, error)

WXAppDecript 小程序解密

func (*WXMiniClient) WXAppSign

func (c *WXMiniClient) WXAppSign(rawdata, sessionkey string) string

WXAppSign 小程序签名验证

type WXPhoneInfo

type WXPhoneInfo struct {
	Phone     string `json:"phoneNumber"`
	PurePhone string `json:"purePhoneNumber"`
	Country   string `json:"countryCode"`
	WaterMark struct {
		AppID     string `json:"appid"`
		Timestamp int64  `json:"timestamp"`
	} `json:"watermark"`
}

WXPhoneInfo 微信账号绑定电话信息

type WXSexType

type WXSexType byte

func (WXSexType) String

func (t WXSexType) String() string

type WXUserInfo

type WXUserInfo struct {
	OpenID     string    `json:"openid"`
	NickName   string    `json:"nickname"`
	Gender     WXSexType `json:"gender"`
	Language   string    `json:"language"`
	City       string    `json:"city"`
	Province   string    `json:"province"`
	Country    string    `json:"country"`
	HeadImgUrl string    `json:"avatarUrl"`
	UnionID    string    `json:"unionId"`
	WaterMark  struct {
		AppID     string `json:"appid"`
		Timestamp int64  `json:"timestamp"`
	} `json:"watermark"`
}

WXUserInfo 微信小程序用户信息