wxacode

README

微信小程序码 SDK

Documentation

Overview

微信小程序码 SDK

Index

• func Create(clt *core.Client, request *QrcodeRequest) (data []byte, err error)
• func Get(clt *core.Client, request *QrcodeRequest) (data []byte, err error)
• func GetUnlimited(clt *core.Client, request *QrcodeRequest) (data []byte, err error)
• func PostJSON(clt *core.Client, incompleteURL string, request interface{}) (data []byte, err error)
• type LineColor
• type QrcodeRequest

Functions

func Create

func Create(clt *core.Client, request *QrcodeRequest) (data []byte, err error)

func Get

func Get(clt *core.Client, request *QrcodeRequest) (data []byte, err error)

func GetUnlimited

func GetUnlimited(clt *core.Client, request *QrcodeRequest) (data []byte, err error)

func PostJSON

func PostJSON(clt *core.Client, incompleteURL string, request interface{}) (data []byte, err error)

Types

type LineColor

type LineColor struct {
	R string `json:"r"`
	G string `json:"g"`
	B string `json:"b"`
}

type QrcodeRequest

type QrcodeRequest struct {
	// Path 扫码进入的小程序页面路径，最大长度 128 字节，不能为空；对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"，即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}。
	Path string `json:"path,omitempty"`
	// Page 必须是已经发布的小程序存在的页面（否则报错），例如 pages/index/index, 根路径前不要填加 /,不能携带参数（参数请放在scene字段里），如果不填写这个字段，默认跳主页面
	Page string `json:"page,omitempty"`
	// Width 二维码的宽度，单位 px。最小 280px，最大 1280px
	Width int `json:"width"`
	// Scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
	Scene string `json:"scene,omitempty"`
	// AutoColor 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
	AutoColor bool `json:"auto_color"`
	// IsHyaline 是否需要透明底色，为 true 时，生成透明底色的小程序码
	IsHyaline bool `json:"is_hyaline,omitempty"`
	// LineColor auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示
	LineColor *LineColor `json:"line_color,omitempty"`
	// EnvVersion 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"。默认是正式版。
	EnvVersion string `json:"env_version,omitempty"`
	// CheckPath 默认是true，检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在， 但page 有数量上限（60000个）请勿滥用。
	CheckPath bool `json:"check_path,omitempty"`
}