jms

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 20, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package jms 包含ONS消息服务相关结构体

https://open.taobao.com/API.htm?docType=2&docId=25634

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MsgGroupDo added in v1.2.0 

type MsgGroupDo struct {
	// 123
	Name string `json:"name,omitempty" xml:"name,omitempty"`
}

MsgGroupDo 结构体

type TaobaojushitajmsgroupgetAPIRequest added in v1.3.1 

type TaobaojushitajmsgroupgetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaojushitajmsgroupgetAPIRequest 查询ONS分组 API请求 taobao.jushita.jms.group.get

查询当前appkey在ONS中已有的分组

func NewTaobaojushitajmsgroupgetRequest added in v1.3.1 

func NewTaobaojushitajmsgroupgetRequest() *TaobaojushitajmsgroupgetAPIRequest

NewTaobaojushitajmsgroupgetRequest 初始化TaobaojushitajmsgroupgetAPIRequest对象

func (TaobaojushitajmsgroupgetAPIRequest) GetApiMethodName added in v1.3.1 

func (r TaobaojushitajmsgroupgetAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaojushitajmsgroupgetAPIRequest) GetApiParams added in v1.3.1 

func (r TaobaojushitajmsgroupgetAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaojushitajmsgroupgetAPIRequest) GetGroupNames added in v1.3.1 

func (r TaobaojushitajmsgroupgetAPIRequest) GetGroupNames() []string

GetGroupNames GroupNames Getter

func (TaobaojushitajmsgroupgetAPIRequest) GetPageNo added in v1.3.1 

func (r TaobaojushitajmsgroupgetAPIRequest) GetPageNo() int64

GetPageNo PageNo Getter

func (TaobaojushitajmsgroupgetAPIRequest) GetPageSize added in v1.3.1 

func (r TaobaojushitajmsgroupgetAPIRequest) GetPageSize() int64

GetPageSize PageSize Getter

func (TaobaojushitajmsgroupgetAPIRequest) GetRawParams added in v1.3.1 

func (r TaobaojushitajmsgroupgetAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (*TaobaojushitajmsgroupgetAPIRequest) SetGroupNames added in v1.3.1 

func (r *TaobaojushitajmsgroupgetAPIRequest) SetGroupNames(_groupNames []string) error

SetGroupNames is GroupNames Setter 要查询分组的名称，多个分组用半角逗号分隔，不传代表查询所有分组信息，但不会返回组下面的用户信息。如果应用没有设置分组则返回空。组名不能以default开头，default开头是系统默认的组。

func (*TaobaojushitajmsgroupgetAPIRequest) SetPageNo added in v1.3.1 

func (r *TaobaojushitajmsgroupgetAPIRequest) SetPageNo(_pageNo int64) error

SetPageNo is PageNo Setter 页码

func (*TaobaojushitajmsgroupgetAPIRequest) SetPageSize added in v1.3.1 

func (r *TaobaojushitajmsgroupgetAPIRequest) SetPageSize(_pageSize int64) error

SetPageSize is PageSize Setter 每页返回多少个分组

type TaobaojushitajmsgroupgetAPIResponse added in v1.3.1 

type TaobaojushitajmsgroupgetAPIResponse struct {
	model.CommonResponse
	TaobaojushitajmsgroupgetAPIResponseModel
}

TaobaojushitajmsgroupgetAPIResponse 查询ONS分组 API返回值 taobao.jushita.jms.group.get

查询当前appkey在ONS中已有的分组

type TaobaojushitajmsgroupgetAPIResponseModel added in v1.3.1 

type TaobaojushitajmsgroupgetAPIResponseModel struct {
	XMLName xml.Name `xml:"jushita_jms_group_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 分组信息
	Groups []MsgGroupDo `json:"groups,omitempty" xml:"groups>msg_group_do,omitempty"`
	// 返回的总数
	TotalResults int64 `json:"total_results,omitempty" xml:"total_results,omitempty"`
}

TaobaojushitajmsgroupgetAPIResponseModel is 查询ONS分组 成功返回结果

type TaobaojushitajmstopicsgetAPIRequest added in v1.3.1 

type TaobaojushitajmstopicsgetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaojushitajmstopicsgetAPIRequest 根据用户nick获取开通的消息列表 API请求 taobao.jushita.jms.topics.get

根据用户nick获取开通的消息列表

func NewTaobaojushitajmstopicsgetRequest added in v1.3.1 

func NewTaobaojushitajmstopicsgetRequest() *TaobaojushitajmstopicsgetAPIRequest

NewTaobaojushitajmstopicsgetRequest 初始化TaobaojushitajmstopicsgetAPIRequest对象

func (TaobaojushitajmstopicsgetAPIRequest) GetApiMethodName added in v1.3.1 

func (r TaobaojushitajmstopicsgetAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaojushitajmstopicsgetAPIRequest) GetApiParams added in v1.3.1 

func (r TaobaojushitajmstopicsgetAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaojushitajmstopicsgetAPIRequest) GetNick added in v1.3.1 

func (r TaobaojushitajmstopicsgetAPIRequest) GetNick() string

GetNick Nick Getter

func (TaobaojushitajmstopicsgetAPIRequest) GetRawParams added in v1.3.1 

func (r TaobaojushitajmstopicsgetAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (*TaobaojushitajmstopicsgetAPIRequest) SetNick added in v1.3.1 

func (r *TaobaojushitajmstopicsgetAPIRequest) SetNick(_nick string) error

SetNick is Nick Setter 卖家nick

type TaobaojushitajmstopicsgetAPIResponse added in v1.3.1 

type TaobaojushitajmstopicsgetAPIResponse struct {
	model.CommonResponse
	TaobaojushitajmstopicsgetAPIResponseModel
}

TaobaojushitajmstopicsgetAPIResponse 根据用户nick获取开通的消息列表 API返回值 taobao.jushita.jms.topics.get

根据用户nick获取开通的消息列表

type TaobaojushitajmstopicsgetAPIResponseModel added in v1.3.1 

type TaobaojushitajmstopicsgetAPIResponseModel struct {
	XMLName xml.Name `xml:"jushita_jms_topics_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// topic列表
	Results []string `json:"results,omitempty" xml:"results>string,omitempty"`
	// 错误信息
	ResultMessage string `json:"result_message,omitempty" xml:"result_message,omitempty"`
	// 错误码
	ResultCode string `json:"result_code,omitempty" xml:"result_code,omitempty"`
}

TaobaojushitajmstopicsgetAPIResponseModel is 根据用户nick获取开通的消息列表 成功返回结果

type TaobaojushitajmsuseraddAPIRequest added in v1.3.1 

type TaobaojushitajmsuseraddAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaojushitajmsuseraddAPIRequest 添加ONS消息同步用户 API请求 taobao.jushita.jms.user.add

添加ONS消息同步用户

func NewTaobaojushitajmsuseraddRequest added in v1.3.1 

func NewTaobaojushitajmsuseraddRequest() *TaobaojushitajmsuseraddAPIRequest

NewTaobaojushitajmsuseraddRequest 初始化TaobaojushitajmsuseraddAPIRequest对象

func (TaobaojushitajmsuseraddAPIRequest) GetApiMethodName added in v1.3.1 

func (r TaobaojushitajmsuseraddAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaojushitajmsuseraddAPIRequest) GetApiParams added in v1.3.1 

func (r TaobaojushitajmsuseraddAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaojushitajmsuseraddAPIRequest) GetRawParams added in v1.3.1 

func (r TaobaojushitajmsuseraddAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (TaobaojushitajmsuseraddAPIRequest) GetTopicNames added in v1.3.1 

func (r TaobaojushitajmsuseraddAPIRequest) GetTopicNames() []string

GetTopicNames TopicNames Getter

func (*TaobaojushitajmsuseraddAPIRequest) SetTopicNames added in v1.3.1 

func (r *TaobaojushitajmsuseraddAPIRequest) SetTopicNames(_topicNames []string) error

SetTopicNames is TopicNames Setter topic列表,不填则继承appkey所订阅的topic

type TaobaojushitajmsuseraddAPIResponse added in v1.3.1 

type TaobaojushitajmsuseraddAPIResponse struct {
	model.CommonResponse
	TaobaojushitajmsuseraddAPIResponseModel
}

TaobaojushitajmsuseraddAPIResponse 添加ONS消息同步用户 API返回值 taobao.jushita.jms.user.add

添加ONS消息同步用户

type TaobaojushitajmsuseraddAPIResponseModel added in v1.3.1 

type TaobaojushitajmsuseraddAPIResponseModel struct {
	XMLName xml.Name `xml:"jushita_jms_user_add_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 是否成功，如果失败请看错误信息
	IsSuccess bool `json:"is_success,omitempty" xml:"is_success,omitempty"`
}

TaobaojushitajmsuseraddAPIResponseModel is 添加ONS消息同步用户 成功返回结果

type TaobaojushitajmsuserdeleteAPIRequest added in v1.3.1 

type TaobaojushitajmsuserdeleteAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaojushitajmsuserdeleteAPIRequest 删除ONS消息同步用户 API请求 taobao.jushita.jms.user.delete

删除ONS消息同步用户，删除后用户的消息将不会推送到聚石塔的ONS中

func NewTaobaojushitajmsuserdeleteRequest added in v1.3.1 

func NewTaobaojushitajmsuserdeleteRequest() *TaobaojushitajmsuserdeleteAPIRequest

NewTaobaojushitajmsuserdeleteRequest 初始化TaobaojushitajmsuserdeleteAPIRequest对象

func (TaobaojushitajmsuserdeleteAPIRequest) GetApiMethodName added in v1.3.1 

func (r TaobaojushitajmsuserdeleteAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaojushitajmsuserdeleteAPIRequest) GetApiParams added in v1.3.1 

func (r TaobaojushitajmsuserdeleteAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaojushitajmsuserdeleteAPIRequest) GetRawParams added in v1.3.1 

func (r TaobaojushitajmsuserdeleteAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (TaobaojushitajmsuserdeleteAPIRequest) GetUserNick added in v1.3.1 

func (r TaobaojushitajmsuserdeleteAPIRequest) GetUserNick() string

GetUserNick UserNick Getter

func (*TaobaojushitajmsuserdeleteAPIRequest) SetUserNick added in v1.3.1 

func (r *TaobaojushitajmsuserdeleteAPIRequest) SetUserNick(_userNick string) error

SetUserNick is UserNick Setter 需要停止同步消息的用户nick

type TaobaojushitajmsuserdeleteAPIResponse added in v1.3.1 

type TaobaojushitajmsuserdeleteAPIResponse struct {
	model.CommonResponse
	TaobaojushitajmsuserdeleteAPIResponseModel
}

TaobaojushitajmsuserdeleteAPIResponse 删除ONS消息同步用户 API返回值 taobao.jushita.jms.user.delete

删除ONS消息同步用户，删除后用户的消息将不会推送到聚石塔的ONS中

type TaobaojushitajmsuserdeleteAPIResponseModel added in v1.3.1 

type TaobaojushitajmsuserdeleteAPIResponseModel struct {
	XMLName xml.Name `xml:"jushita_jms_user_delete_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 是否删除成功
	IsSuccess bool `json:"is_success,omitempty" xml:"is_success,omitempty"`
}

TaobaojushitajmsuserdeleteAPIResponseModel is 删除ONS消息同步用户 成功返回结果

type TaobaojushitajmsusergetAPIRequest added in v1.3.1 

type TaobaojushitajmsusergetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaojushitajmsusergetAPIRequest 查询某个用户是否同步消息 API请求 taobao.jushita.jms.user.get

查询某个用户是否同步消息，只支持单个查询

func NewTaobaojushitajmsusergetRequest added in v1.3.1 

func NewTaobaojushitajmsusergetRequest() *TaobaojushitajmsusergetAPIRequest

NewTaobaojushitajmsusergetRequest 初始化TaobaojushitajmsusergetAPIRequest对象

func (TaobaojushitajmsusergetAPIRequest) GetApiMethodName added in v1.3.1 

func (r TaobaojushitajmsusergetAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaojushitajmsusergetAPIRequest) GetApiParams added in v1.3.1 

func (r TaobaojushitajmsusergetAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaojushitajmsusergetAPIRequest) GetRawParams added in v1.3.1 

func (r TaobaojushitajmsusergetAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (TaobaojushitajmsusergetAPIRequest) GetUserNick added in v1.3.1 

func (r TaobaojushitajmsusergetAPIRequest) GetUserNick() string

GetUserNick UserNick Getter

func (*TaobaojushitajmsusergetAPIRequest) SetUserNick added in v1.3.1 

func (r *TaobaojushitajmsusergetAPIRequest) SetUserNick(_userNick string) error

SetUserNick is UserNick Setter 需要查询的用户名

type TaobaojushitajmsusergetAPIResponse added in v1.3.1 

type TaobaojushitajmsusergetAPIResponse struct {
	model.CommonResponse
	TaobaojushitajmsusergetAPIResponseModel
}

TaobaojushitajmsusergetAPIResponse 查询某个用户是否同步消息 API返回值 taobao.jushita.jms.user.get

查询某个用户是否同步消息，只支持单个查询

type TaobaojushitajmsusergetAPIResponseModel added in v1.3.1 

type TaobaojushitajmsusergetAPIResponseModel struct {
	XMLName xml.Name `xml:"jushita_jms_user_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 同步的用户信息
	OnsUser *TmcUser `json:"ons_user,omitempty" xml:"ons_user,omitempty"`
}

TaobaojushitajmsusergetAPIResponseModel is 查询某个用户是否同步消息 成功返回结果

type TmcUser 

type TmcUser struct {
	// 用户首次开通时间
	Created string `json:"created,omitempty" xml:"created,omitempty"`
	// 用户最后开通时间
	Modified string `json:"modified,omitempty" xml:"modified,omitempty"`
	// 用户昵称
	UserNick string `json:"user_nick,omitempty" xml:"user_nick,omitempty"`
	// 用户ID
	UserId int64 `json:"user_id,omitempty" xml:"user_id,omitempty"`
	// 用户授权是否有效，true表示授权有效，false表示授权过期
	IsValid bool `json:"is_valid,omitempty" xml:"is_valid,omitempty"`
}

TmcUser 结构体

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.