xiaomi

Documentation

Index

• Constants
• type Callback
• type Extra
• type Message
  • func (m *Message) SetAlias(alias string)
  • func (m *Message) SetDescription(description string)
  • func (m *Message) SetIntentUri(intentUri string)
  • func (m *Message) SetNotifyId(notifyId int)
  • func (m *Message) SetNotifyType(notifyType int)
  • func (m *Message) SetPayload(payLoad string)
  • func (m *Message) SetRegistrationId(rid string)
  • func (m *Message) SetRestrictedPackageName(restrictedPackageName string)
  • func (m *Message) SetSoundUri(soundUri string)
  • func (m *Message) SetTitle(title string)
  • func (m *Message) SetTopic(topic string)
  • func (m *Message) SetTopicOp(topicOp string)
  • func (m *Message) SetTopics(topics string)
  • func (m *Message) SetUserAccount(account string)
  • func (m *Message) SetWebUri(webUri string)
• type SendResponse
• type Sender
  • func NewSender(secret, packages string, debug ...bool) *Sender
  • func (sender *Sender) SendByAlias(message *Message) (*SendResponse, error)
  • func (sender *Sender) SendByAll(message *Message) (*SendResponse, error)
  • func (sender *Sender) SendByMultiTopic(message *Message) (*SendResponse, error)
  • func (sender *Sender) SendByRegid(message *Message) (*SendResponse, error)
  • func (sender *Sender) SendByTopic(message *Message) (*SendResponse, error)
• type Target

Constants

const (
	// 表示通知栏消息
	PASS_THROUGH_BY_NOTICE = 0
	// 表示透传消息
	PASS_THROUGH_BY_TCP = 1

	// 所有类型
	NOTIFY_TYPE_DEFAULT_ALL = -1
	// 使用默认提示音提示
	NOTIFY_TYPE_DEFAULT_SOUND = 1
	// 使用默认震动提示
	NOTIFY_TYPE_DEFAULT_VIBRATE = 2
	// 使用默认led灯光提示
	NOTIFY_TYPE_DEFAULT_LIGHTS = 4

	// 允许弹出通知栏消息
	NOTIFY_FOREGROUND_YES = 1
	// 不允许弹出通知栏消息
	NOTIFY_FOREGROUND_NO = 0
)

const (
	// 基础请求url
	BaseReqUrl = "https://api.xmpush.xiaomi.com"
)

Types

type Callback

type Callback struct {
	// 可选项，开启消息回执。消息发送后，推送系统能发送回执给开发者，告知开发者这些消息的送达、点击或发送失败状态。
	// 将extra.callback的值设置为第三方接收回执的http接口
	Callback string `json:"extra.callback,omitempty"`
	// 可选项，第三方自定义回执参数，最大长度64字节
	Param string `json:"extra.callback.param,omitempty"`
	// 可选项，表示回执类型。详细用法请参见《服务端Java SDK文档》中“消息回执”一节中的callback.type字段
	Type int `json:"extra.callback.type,omitempty"`
}

Callback 消息发送回执

type Extra

type Extra struct {
	// 可选项，自定义通知栏消息铃声。extra.sound_uri的值设置为铃声的URI。（请参见《服务端Java SDK文档》中的“自定义铃声”一节。）
	// 注：铃声文件放在Android app的raw目录下。
	SoundUri string `json:"extra.sound_uri,omitempty"`
	// 可选项，开启通知消息在状态栏滚动显示。
	Ticker string `json:"extra.ticker,omitempty"`
	// 可选项，开启/关闭app在前台时的通知弹出。
	// 当extra.notify_foreground值为”1″时，app会弹出通知栏消息；
	// 当extra.notify_foreground值为”0″时，app不会弹出通知栏消息。
	// 注：默认情况下会弹出通知栏消息。
	//（请参见《服务端Java SDK文档》中的“控制App前台通知弹出”一节。）
	NotifyForeground string `json:"extra.notify_foreground,omitempty"`
	// 可选项，预定义通知栏消息的点击行为。通过设置extra.notify_effect的值以得到不同的预定义点击行为。
	// “1″：通知栏点击后打开app的Launcher Activity。
	// “2″：通知栏点击后打开app的任一Activity（开发者还需要传入extra.intent_uri）。
	// “3″：通知栏点击后打开网页（开发者还需要传入extra.web_uri）。
	//（请参见《服务端Java SDK文档》中的“预定义通知栏通知的点击行为”一节。）
	NotifyEffect string `json:"extra.notify_effect,omitempty"`
	// 可选项，打开当前app的任一组件。
	IntentUri string `json:"extra.intent_uri,omitempty"`
	// 可选项，打开某一个网页。
	WebUri string `json:"extra.web_uri,omitempty"`
	// 可选项，控制是否需要进行平缓发送。默认不支持。value代表平滑推送的速度。
	// 注：服务端支持最低3000/s的qps。也就是说，如果将平滑推送设置为1000，那么真实的推送速度是3000/s。
	FlowControl int `json:"extra.flow_control,omitempty"`
	// 可选项，使用推送批次（JobKey）功能聚合消息。
	// 客户端会按照jobkey去重，即相同jobkey的消息只展示第一条，其他的消息会被忽略。
	// 合法的jobkey由数字（[0-9]），大小写字母（[a-zA-Z]），下划线（_）和中划线（-）组成，长度不大于20个字符，且不能以下划线(_)开头。
	Jobkey string `json:"extra.jobkey,omitempty"`

	// 消息发送回执
	Callback Callback `json:"callback,omitempty"`

	// 可选项，可以接收消息的设备的语言范围，用逗号分隔。当前设备的local的获取方法：
	// Locale.getDefault().toString()
	// 比如，中国大陆用zh_CN表示。
	Locale string `json:"extra.locale,omitempty"`
	// 可选项，无法收到消息的设备的语言范围，逗号分隔。
	LocaleNotIn string `json:"extra.locale_not_in,omitempty"`
	// 可选项，model支持三种用法。
	// 可以收到消息的设备的机型范围，逗号分隔。当前设备的model的获取方法： Build.MODEL
	// 比如，小米手机4移动版用”MI 4LTE”表示。
	// 可以收到消息的设备的品牌范围，逗号分割。比如，三星手机用”samsung”表示。 （目前覆盖42个主流品牌，对应关系见附录”品牌表”）
	// 可以收到消息的设备的价格范围，逗号分隔。比如，0-999价格的设备用”0-999″表示。 （目前覆盖4个价格区间，对应关系见附录”价格表”）
	Model string `json:"extra.model,omitempty"`
	// 可选项，无法收到消息的设备的机型范围，逗号分隔。
	ModelNotIn string `json:"extra.model_not_in,omitempty"`
	// 可以接收消息的app版本号，用逗号分割。安卓app版本号来源于manifest文件中的”android:versionName”的值。
	// 注：目前支持MiPush_SDK_Client_2_2_12_sdk.jar（及以后）的版本。
	AppVersion string `json:"extra.app_version,omitempty"`
	// 无法接收消息的app版本号，用逗号分割。
	AppVersionNotIn string `json:"extra.app_version_not_in,omitempty"`
	// 可选项，指定在特定的网络环境下才能接收到消息。目前仅支持指定”wifi”。
	Connpt string `json:"extra.connpt,omitempty"`
	// 可选项，extra.only_send_once的值设置为1，表示该消息仅在设备在线时发送一次，不缓存离线消息进行多次下发
	OnlySendOnce string `json:"extra.only_send_once,omitempty"`
}

Extra 额外参数

type Message

type Message struct {
	// 消息的内容。（注意：需要对payload字符串做urlencode处理）
	Payload string `json:"payload,omitempty"`
	// App的包名。备注：V2版本支持一个包名，V3版本支持多包名（中间用逗号分割）。
	RestrictedPackageName string `json:"restricted_package_name,omitempty"`
	// pass_through的值可以为： 0 表示通知栏消息 1 表示透传消息
	PassThrough int `json:"pass_through,omitempty"`
	// 通知栏展示的通知的标题，不允许全是空白字符，长度小于50， 一个中英文字符均计算为1（通知栏消息必填）。
	Title string `json:"title,omitempty"`
	// 通知栏展示的通知的描述，不允许全是空白字符，长度小于128，一个中英文字符均计算为1（通知栏消息必填）。
	Description string `json:"description,omitempty"`
	// notify_type的值可以是DEFAULT_ALL或者以下其他几种的OR组合：
	// DEFAULT_ALL = -1;
	// DEFAULT_SOUND  = 1;  // 使用默认提示音提示；
	// DEFAULT_VIBRATE = 2;  // 使用默认震动提示；
	// DEFAULT_LIGHTS = 4;   // 使用默认led灯光提示；
	NotifyType int `json:"notify_type,omitempty"`
	// 可选项。如果用户离线，设置消息在服务器保存的时间，单位：ms。服务器默认最长保留两周。
	TimeToLive int64 `json:"time_to_live,omitempty"`
	// 可选项。定时发送消息。用自1970年1月1日以来00:00:00.0 UTC时间表示（以毫秒为单位的时间）。注：仅支持七天内的定时消息。
	TimeToSend int64 `json:"time_to_send,omitempty"`
	// 可选项。默认情况下，通知栏只显示一条推送消息。如果通知栏要显示多条推送消息，需要针对不同的消息设置不同的notify_id（相同notify_id的通知栏消息会覆盖之前的），且要求notify_id为取值在0~2147483647的整数。
	NotifyId int `json:"notify_id,omitempty"`

	// 额外参数
	Extra

	// 推送目标
	Target
}

Android消息体

func (*Message) SetAlias

func (m *Message) SetAlias(alias string)

SetAlias

func (*Message) SetDescription

func (m *Message) SetDescription(description string)

SetDescription

func (*Message) SetIntentUri

func (m *Message) SetIntentUri(intentUri string)

SetIntentUri

func (*Message) SetNotifyId

func (m *Message) SetNotifyId(notifyId int)

SetNotifyId

func (*Message) SetNotifyType

func (m *Message) SetNotifyType(notifyType int)

SetNotifyType

func (*Message) SetPayload

func (m *Message) SetPayload(payLoad string)

SetPayload

func (*Message) SetRegistrationId

func (m *Message) SetRegistrationId(rid string)

SetRegistrationId

func (*Message) SetRestrictedPackageName

func (m *Message) SetRestrictedPackageName(restrictedPackageName string)

SetRestrictedPackageName

func (*Message) SetSoundUri

func (m *Message) SetSoundUri(soundUri string)

SetSoundUri

func (*Message) SetTitle

func (m *Message) SetTitle(title string)

SetTitle

func (*Message) SetTopic

func (m *Message) SetTopic(topic string)

SetTopic

func (*Message) SetTopicOp

func (m *Message) SetTopicOp(topicOp string)

SetTopicOp

func (*Message) SetTopics

func (m *Message) SetTopics(topics string)

SetTopics

func (*Message) SetUserAccount

func (m *Message) SetUserAccount(account string)

SetUserAccount

func (*Message) SetWebUri

func (m *Message) SetWebUri(webUri string)

SetWebUri

type SendResponse

type SendResponse struct {
	// "ok" 表示成功
	Result string `json:"result"`
	// 对发送消息失败原因的解释
	Reason string `json:"reason"`
	// 0表示成功，非0表示失败
	Code int `json:"code"`
	// 发送返回状态描述(成功/失败)
	Description string `json:"description"`

	// 一些额外字段
	TraceID string `json:"trace_id"`
	Data    struct {
		DayAcked string `json:"day_acked"`
		DayQuota string `json:"day_quota"`
	} `json:"data"`
}

SendResponse 发送响应

type Sender

type Sender struct {
	// app secret
	Secret string
	// 包名，用逗号(,)分隔
	Packages string
	// 显示请求日志
	Debug bool
}

Sender

func NewSender

func NewSender(secret, packages string, debug ...bool) *Sender

NewSender

func (*Sender) SendByAlias

func (sender *Sender) SendByAlias(message *Message) (*SendResponse, error)

SendByAlias 向某个alias或一组alias列表推送某条消息（这些alias可以属于不同的包名）

func (*Sender) SendByAll

func (sender *Sender) SendByAll(message *Message) (*SendResponse, error)

SendByAlias 向所有设备推送某条消息（可以指定一个或多个包名）

func (*Sender) SendByMultiTopic

func (sender *Sender) SendByMultiTopic(message *Message) (*SendResponse, error)

SendByAlias 向多个topic推送单条消息（可以指定一个或多个包名）

func (*Sender) SendByRegid

func (sender *Sender) SendByRegid(message *Message) (*SendResponse, error)

SendByRegid 向某个regid或一组regid列表推送某条消息（这些regId可以属于不同的包名）

func (*Sender) SendByTopic

func (sender *Sender) SendByTopic(message *Message) (*SendResponse, error)

SendByTopic 向某个topic推送某条消息（可以指定一个或多个包名）

type Target

type Target struct {
	// 根据registration_id，发送消息到指定设备上。可以提供多个registration_id，发送给一组设备，不同的registration_id之间用“,”分割。
	// 参数仅适用于“/message/regid”HTTP API。（注意：需要对payload字符串做urlencode处理）
	RegistrationId string `json:"registration_id,omitempty"`
	// 根据alias，发送消息到指定的设备。可以提供多个alias，发送给一组设备，不同的alias之间用“,”分割。
	// 参数仅适用于“/message/alias”HTTP API。
	Alias string `json:"alias,omitempty"`
	// 根据user_account，发送消息给设置了该user_account的所有设备。
	// 可以提供多个user_account，user_account之间用“,”分割。参数仅适用于“/message/user_account”HTTP API。
	UserAccount string `json:"user_account,omitempty"`
	// 根据topic，发送消息给订阅了该topic的所有设备。
	// 参数仅适用于“/message/topic”HTTP API。
	Topic string `json:"topic,omitempty"`
	// topic列表，使用;$;分割。注: topics参数需要和topic_op参数配合使用，另外topic的数量不能超过5。
	// 参数仅适用于“/message/multi_topic”HTTP API。
	Topics string `json:"topics,omitempty"`
	// topic之间的操作关系。支持以下三种：
	// UNION并集
	// INTERSECTION交集
	// EXCEPT差集
	// 例如：topics的列表元素是[A, B, C, D]，则并集结果是A∪B∪C∪D，交集的结果是A ∩B ∩C ∩D，差集的结果是A-B-C-D。
	// 参数仅适用于“/message/multi_topic”HTTP API。
	TopicOp string `json:"topic_op,omitempty"`
}

Target 推送目标