jms

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

ONS消息服务 model

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

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 TaobaoJushitaJmsGroupDeleteAPIRequest added in v1.2.0 

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

删除ONS分组 API请求 taobao.jushita.jms.group.delete

删除ONS分组

func NewTaobaoJushitaJmsGroupDeleteRequest 

func NewTaobaoJushitaJmsGroupDeleteRequest() *TaobaoJushitaJmsGroupDeleteAPIRequest

初始化TaobaoJushitaJmsGroupDeleteAPIRequest对象

func (TaobaoJushitaJmsGroupDeleteAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoJushitaJmsGroupDeleteAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoJushitaJmsGroupDeleteAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoJushitaJmsGroupDeleteAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoJushitaJmsGroupDeleteAPIRequest) GetGroupName added in v1.2.0 

func (r TaobaoJushitaJmsGroupDeleteAPIRequest) GetGroupName() string

GroupName Getter

func (TaobaoJushitaJmsGroupDeleteAPIRequest) GetNicks added in v1.2.0 

func (r TaobaoJushitaJmsGroupDeleteAPIRequest) GetNicks() []string

Nicks Getter

func (TaobaoJushitaJmsGroupDeleteAPIRequest) GetUserPlatform added in v1.2.0 

func (r TaobaoJushitaJmsGroupDeleteAPIRequest) GetUserPlatform() string

UserPlatform Getter

func (*TaobaoJushitaJmsGroupDeleteAPIRequest) SetGroupName added in v1.2.0 

func (r *TaobaoJushitaJmsGroupDeleteAPIRequest) SetGroupName(_groupName string) error

GroupName Setter 分组名称，分组删除后，用户的消息将会存储于默认分组中。警告：由于分组已经删除，用户之前未消费的消息将无法再获取。不能以default开头，default开头为系统默认组。

func (*TaobaoJushitaJmsGroupDeleteAPIRequest) SetNicks added in v1.2.0 

func (r *TaobaoJushitaJmsGroupDeleteAPIRequest) SetNicks(_nicks []string) error

Nicks Setter 用户列表，不传表示删除整个分组，如果用户全部删除后，也会自动删除整个分组

func (*TaobaoJushitaJmsGroupDeleteAPIRequest) SetUserPlatform added in v1.2.0 

func (r *TaobaoJushitaJmsGroupDeleteAPIRequest) SetUserPlatform(_userPlatform string) error

UserPlatform Setter 用户所属于的平台类型，tbUIC:淘宝用户; icbu: icbu用户

type TaobaoJushitaJmsGroupDeleteAPIResponse 

type TaobaoJushitaJmsGroupDeleteAPIResponse struct {
	model.CommonResponse
	TaobaoJushitaJmsGroupDeleteAPIResponseModel
}

删除ONS分组 API返回值 taobao.jushita.jms.group.delete

删除ONS分组

type TaobaoJushitaJmsGroupDeleteAPIResponseModel added in v1.2.0 

type TaobaoJushitaJmsGroupDeleteAPIResponseModel struct {
	XMLName xml.Name `xml:"jushita_jms_group_delete_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 操作结果
	IsSuccess bool `json:"is_success,omitempty" xml:"is_success,omitempty"`
}

删除ONS分组 成功返回结果

type TaobaoJushitaJmsGroupGetAPIRequest added in v1.2.0 

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

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

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

func NewTaobaoJushitaJmsGroupGetRequest 

func NewTaobaoJushitaJmsGroupGetRequest() *TaobaoJushitaJmsGroupGetAPIRequest

初始化TaobaoJushitaJmsGroupGetAPIRequest对象

func (TaobaoJushitaJmsGroupGetAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoJushitaJmsGroupGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoJushitaJmsGroupGetAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoJushitaJmsGroupGetAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoJushitaJmsGroupGetAPIRequest) GetGroupNames added in v1.2.0 

func (r TaobaoJushitaJmsGroupGetAPIRequest) GetGroupNames() []string

GroupNames Getter

func (TaobaoJushitaJmsGroupGetAPIRequest) GetPageNo added in v1.2.0 

func (r TaobaoJushitaJmsGroupGetAPIRequest) GetPageNo() int64

PageNo Getter

func (TaobaoJushitaJmsGroupGetAPIRequest) GetPageSize added in v1.2.0 

func (r TaobaoJushitaJmsGroupGetAPIRequest) GetPageSize() int64

PageSize Getter

func (*TaobaoJushitaJmsGroupGetAPIRequest) SetGroupNames added in v1.2.0 

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

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

func (*TaobaoJushitaJmsGroupGetAPIRequest) SetPageNo added in v1.2.0 

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

PageNo Setter 页码

func (*TaobaoJushitaJmsGroupGetAPIRequest) SetPageSize added in v1.2.0 

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

PageSize Setter 每页返回多少个分组

type TaobaoJushitaJmsGroupGetAPIResponse 

type TaobaoJushitaJmsGroupGetAPIResponse struct {
	model.CommonResponse
	TaobaoJushitaJmsGroupGetAPIResponseModel
}

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

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

type TaobaoJushitaJmsGroupGetAPIResponseModel added in v1.2.0 

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

查询ONS分组 成功返回结果

type TaobaoJushitaJmsTopicsGetAPIRequest added in v1.2.0 

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

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

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

func NewTaobaoJushitaJmsTopicsGetRequest 

func NewTaobaoJushitaJmsTopicsGetRequest() *TaobaoJushitaJmsTopicsGetAPIRequest

初始化TaobaoJushitaJmsTopicsGetAPIRequest对象

func (TaobaoJushitaJmsTopicsGetAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoJushitaJmsTopicsGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoJushitaJmsTopicsGetAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoJushitaJmsTopicsGetAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoJushitaJmsTopicsGetAPIRequest) GetNick added in v1.2.0 

func (r TaobaoJushitaJmsTopicsGetAPIRequest) GetNick() string

Nick Getter

func (*TaobaoJushitaJmsTopicsGetAPIRequest) SetNick added in v1.2.0 

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

Nick Setter 卖家nick

type TaobaoJushitaJmsTopicsGetAPIResponse 

type TaobaoJushitaJmsTopicsGetAPIResponse struct {
	model.CommonResponse
	TaobaoJushitaJmsTopicsGetAPIResponseModel
}

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

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

type TaobaoJushitaJmsTopicsGetAPIResponseModel added in v1.2.0 

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

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

type TaobaoJushitaJmsUserAddAPIRequest added in v1.2.0 

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

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

添加ONS消息同步用户

func NewTaobaoJushitaJmsUserAddRequest 

func NewTaobaoJushitaJmsUserAddRequest() *TaobaoJushitaJmsUserAddAPIRequest

初始化TaobaoJushitaJmsUserAddAPIRequest对象

func (TaobaoJushitaJmsUserAddAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoJushitaJmsUserAddAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoJushitaJmsUserAddAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoJushitaJmsUserAddAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoJushitaJmsUserAddAPIRequest) GetTopicNames added in v1.2.0 

func (r TaobaoJushitaJmsUserAddAPIRequest) GetTopicNames() []string

TopicNames Getter

func (*TaobaoJushitaJmsUserAddAPIRequest) SetTopicNames added in v1.2.0 

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

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

type TaobaoJushitaJmsUserAddAPIResponse 

type TaobaoJushitaJmsUserAddAPIResponse struct {
	model.CommonResponse
	TaobaoJushitaJmsUserAddAPIResponseModel
}

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

添加ONS消息同步用户

type TaobaoJushitaJmsUserAddAPIResponseModel added in v1.2.0 

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"`
}

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

type TaobaoJushitaJmsUserDeleteAPIRequest added in v1.2.0 

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

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

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

func NewTaobaoJushitaJmsUserDeleteRequest 

func NewTaobaoJushitaJmsUserDeleteRequest() *TaobaoJushitaJmsUserDeleteAPIRequest

初始化TaobaoJushitaJmsUserDeleteAPIRequest对象

func (TaobaoJushitaJmsUserDeleteAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoJushitaJmsUserDeleteAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoJushitaJmsUserDeleteAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoJushitaJmsUserDeleteAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoJushitaJmsUserDeleteAPIRequest) GetUserNick added in v1.2.0 

func (r TaobaoJushitaJmsUserDeleteAPIRequest) GetUserNick() string

UserNick Getter

func (*TaobaoJushitaJmsUserDeleteAPIRequest) SetUserNick added in v1.2.0 

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

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

type TaobaoJushitaJmsUserDeleteAPIResponse 

type TaobaoJushitaJmsUserDeleteAPIResponse struct {
	model.CommonResponse
	TaobaoJushitaJmsUserDeleteAPIResponseModel
}

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

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

type TaobaoJushitaJmsUserDeleteAPIResponseModel added in v1.2.0 

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"`
}

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

type TaobaoJushitaJmsUserGetAPIRequest added in v1.2.0 

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

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

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

func NewTaobaoJushitaJmsUserGetRequest 

func NewTaobaoJushitaJmsUserGetRequest() *TaobaoJushitaJmsUserGetAPIRequest

初始化TaobaoJushitaJmsUserGetAPIRequest对象

func (TaobaoJushitaJmsUserGetAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoJushitaJmsUserGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoJushitaJmsUserGetAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoJushitaJmsUserGetAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoJushitaJmsUserGetAPIRequest) GetUserNick added in v1.2.0 

func (r TaobaoJushitaJmsUserGetAPIRequest) GetUserNick() string

UserNick Getter

func (*TaobaoJushitaJmsUserGetAPIRequest) SetUserNick added in v1.2.0 

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

UserNick Setter 需要查询的用户名

type TaobaoJushitaJmsUserGetAPIResponse 

type TaobaoJushitaJmsUserGetAPIResponse struct {
	model.CommonResponse
	TaobaoJushitaJmsUserGetAPIResponseModel
}

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

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

type TaobaoJushitaJmsUserGetAPIResponseModel added in v1.2.0 

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"`
}

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

type TmcUser 

type TmcUser struct {
	// 用户昵称
	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"`
	// 用户首次开通时间
	Created string `json:"created,omitempty" xml:"created,omitempty"`
	// 用户最后开通时间
	Modified string `json:"modified,omitempty" xml:"modified,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.