wxminiprogram

README

wxminiprogram

Documentation

Index

• Variables
• type Auth
  • func (auth *Auth) Code2Session(ctx context.Context, code string) (*AuthCode2SessionResp, error)
  • func (auth *Auth) GetAccessToken(ctx context.Context) (*AuthGetAccessTokenResp, error)
• type AuthCode2SessionResp
• type AuthGetAccessTokenResp
• type DataItem
• type ErrorLogger
• type Msg
• type Option
  • func AccessTokenKey(key string) Option
  • func AccessTokenLockerKey(key string) Option
  • func AppID(appid string) Option
  • func HttpClient(httpCli *http.Client) Option
  • func Logger(l ErrorLogger) Option
  • func RedisClient(client redis.UniversalClient) Option
  • func Secret(secret string) Option
• type SDK
  • func NewSDK(opts ...Option) *SDK
  • func (sdk *SDK) AppID() string
  • func (sdk *SDK) Auth() *Auth
  • func (sdk *SDK) SubscribeMessage() *SubscribeMessage
• type SubscribeMessage
  • func (sm *SubscribeMessage) Send(ctx context.Context, accessToken string, msg *Msg) (*SubscribeMessageSendResp, error)
• type SubscribeMessageSendResp

Variables

var (
	URLAuth_Code2Session   = "https://api.weixin.qq.com/sns/jscode2session"
	URLAuth_GetAccessToken = "https://api.weixin.qq.com/cgi-bin/token"

	URLSubscribeMessage_Send = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send"
)

Types

type Auth

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

func (*Auth) Code2Session

func (auth *Auth) Code2Session(ctx context.Context, code string) (*AuthCode2SessionResp, error)

func (*Auth) GetAccessToken

func (auth *Auth) GetAccessToken(ctx context.Context) (*AuthGetAccessTokenResp, error)

type AuthCode2SessionResp

type AuthCode2SessionResp struct {
	ErrCode    int64  `json:"errcode"`
	ErrMsg     string `json:"errmsg"`
	AppID      string
	OpenID     string `json:"openid"`      // 用户唯一标识
	SessionKey string `json:"session_key"` // 会话密钥
	UnionID    string `json:"unionid"`     // 用户在开放平台的唯一标识符，在满足UnionID下发条件的情况下会返回
}

AuthCode2SessionResp 登录凭证校验的返回结果

type AuthGetAccessTokenResp

type AuthGetAccessTokenResp struct {
	ErrCode     int64  `json:"errcode"`
	ErrMsg      string `json:"errmsg"`
	AppID       string
	AccessToken string `json:"access_token"` // string 获取到的凭证
	ExpiresIn   int    `json:"expires_in"`   // number	凭证有效时间，单位：秒。目前是7200秒之内的值
}

type DataItem

type DataItem struct {
	Value any    `json:"value"`
	Color string `json:"color"`
}

DataItem 模版内某个 .DATA 的值

type ErrorLogger

type ErrorLogger interface {
	Error(args ...any)
	Errorf(template string, args ...any)
}

type Msg

type Msg struct {
	ToUser           string               `json:"touser"`            // 必选，接收者（用户）的 openid
	TemplateID       string               `json:"template_id"`       // 必选，所需下发的订阅模板id
	Page             string               `json:"page"`              // 可选，点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
	Data             map[string]*DataItem `json:"data"`              // 必选, 模板内容
	MiniprogramState string               `json:"miniprogram_state"` // 可选，跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
	Lang             string               `json:"lang"`              // 入小程序查看”的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN
}

Msg 订阅消息请求参数

type Option

type Option func(o *options)

func AccessTokenKey

func AccessTokenKey(key string) Option

func AccessTokenLockerKey

func AccessTokenLockerKey(key string) Option

func AppID

func AppID(appid string) Option

func HttpClient

func HttpClient(httpCli *http.Client) Option

func Logger

func Logger(l ErrorLogger) Option

func RedisClient

func RedisClient(client redis.UniversalClient) Option

func Secret

func Secret(secret string) Option

type SDK

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

SDK 微信小程序SDK

func NewSDK

func NewSDK(opts ...Option) *SDK

func (*SDK) AppID

func (sdk *SDK) AppID() string

func (*SDK) Auth

func (sdk *SDK) Auth() *Auth

func (*SDK) SubscribeMessage

func (sdk *SDK) SubscribeMessage() *SubscribeMessage

type SubscribeMessage

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

func (*SubscribeMessage) Send

func (sm *SubscribeMessage) Send(
	ctx context.Context, accessToken string, msg *Msg) (*SubscribeMessageSendResp, error)

Send 发送订阅消息

type SubscribeMessageSendResp

type SubscribeMessageSendResp struct {
	ErrCode int64  `json:"errcode"`
	ErrMsg  string `json:"errmsg"`
	AppID   string
}