urlscheme

Documentation

Index

• type JumpWxa
• type ResGenerateUrlScheme
• type UrlScheme
  • func NewUrlScheme(context *context.Context) *UrlScheme
  • func (urlScheme *UrlScheme) GenerateUrlScheme(param UrlSchemeParam) (openlink string, err error)
• type UrlSchemeParam

Types

type JumpWxa

type JumpWxa struct {
	// path UrlSheme进入的小程序页面路径
	Path string `json:"path,omitempty"`
	// query 通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~%
	Query string `json:"query,omitempty"`
	// envVersion 要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。
	EnvVersion string `json:"env_version,omitempty"`
}

jumpWxa 的结构

type ResGenerateUrlScheme

type ResGenerateUrlScheme struct {
	util.CommonError
	OpenLink string `json:"openlink"`
}

type UrlScheme

type UrlScheme struct {
	*context.Context
}

UrlScheme struct

func NewUrlScheme

func NewUrlScheme(context *context.Context) *UrlScheme

NewUrlScheme 实例

func (*UrlScheme) GenerateUrlScheme

func (urlScheme *UrlScheme) GenerateUrlScheme(param UrlSchemeParam) (openlink string, err error)

Generate 获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。

type UrlSchemeParam

type UrlSchemeParam struct {
	// jumpWxa 跳转到的目标小程序信息。
	JumpWxa JumpWxa `json:"jump_wxa,omitempty"`
	// isExpire 生成的 scheme 码类型，到期失效：true，永久有效：false。注意，永久有效 scheme 和有效时间超过31天的到期失效 scheme 的总数上限为10万个。
	IsExpire bool `json:"is_expire,omitempty"`
	// expireType 到期失效的 scheme 码失效类型，失效时间：0，失效间隔天数：1。
	ExpireType int `json:"expire_type,omitempty"`
	// expireTime 到期失效的 scheme 码的失效时间，为 Unix 时间戳。生成的到期失效 scheme 码在该时间前有效。最长有效期为1年。is_expire 为 true 且 expire_type 为 0 时必填。
	ExpireTime int `json:"expire_time,omitempty"`
	// expireInterval 到期失效的 scheme 码的失效间隔天数。生成的到期失效 scheme 码在该间隔时间到达前有效。最长间隔天数为365天。is_expire 为 true 且 expire_type 为 1 时必填。
	ExpireInterval int `json:"expire_interval,omitempty"`
}

UrlScheme 小程序码参数