message.go

package xiaomipush

import (
	"encoding/json"
	"strconv"
	"strings"
	"time"
)

type Message struct {
	RestrictedPackageName string            `json:"restricted_package_name,omitempty"` // 设置app的多包名packageNames（多包名发送广播消息）。p
	Payload               string            `json:"payload,omitempty"`                 // 消息内容payload
	Title                 string            `json:"title,omitempty"`                   // 通知栏展示的通知的标题
	Description           string            `json:"description,omitempty"`             // 通知栏展示的通知的描述
	PassThrough           int32             `json:"pass_through"`                      // 是否通过透传的方式送给app，1表示透传消息，0表示通知栏消息。
	NotifyType            int32             `json:"notify_type,omitempty"`             // DEFAULT_ALL = -1; DEFAULT_SOUND  = 1;   // 使用默认提示音提示 DEFAULT_VIBRATE = 2;   // 使用默认震动提示 DEFAULT_LIGHTS = 4;    // 使用默认led灯光提示
	TimeToLive            int64             `json:"time_to_live,omitempty"`            // 可选项。如果用户离线，设置消息在服务器保存的时间，单位：ms。服务器默认最长保留两周。
	TimeToSend            int64             `json:"time_to_send,omitempty"`            // 可选项。定时发送消息。timeToSend是以毫秒为单位的时间戳。注：仅支持七天内的定时消息。
	NotifyID              int64             `json:"notify_id"`                         // 可选项。默认情况下，通知栏只显示一条推送消息。如果通知栏要显示多条推送消息，需要针对不同的消息设置不同的notify_id（相同notify_id的通知栏消息会覆盖之前的）。
	Extra                 map[string]string `json:"extra,omitempty"`                   // 可选项，对app提供一些扩展的功能，请参考2.2。除了这些扩展功能，开发者还可以定义一些key和value来控制客户端的行为。注：key和value的字符数不能超过1024，至多可以设置10个key-value键值对。
}

const (
	MaxTimeToSend = time.Hour * 24 * 7
	MaxTimeToLive = time.Hour * 24 * 7 * 2
)

func (m *Message) SetRestrictedPackageName(restrictedPackageNames []string) *Message {
	m.RestrictedPackageName = strings.Join(restrictedPackageNames, ",")
	return m
}

func (m *Message) SetPassThrough(passThrough int32) *Message {
	m.PassThrough = passThrough
	return m
}

func (m *Message) SetNotifyType(notifyType int32) *Message {
	m.NotifyType = notifyType
	return m
}

func (m *Message) SetTimeToSend(tts int64) *Message {
	if time.Since(time.Unix(0, tts*int64(time.Millisecond))) > MaxTimeToSend {
		m.TimeToSend = time.Now().Add(MaxTimeToSend).UnixNano() / 1e6
	} else {
		m.TimeToSend = tts
	}
	return m
}

func (m *Message) SetTimeToLive(ttl int64) *Message {
	if time.Since(time.Unix(0, ttl*int64(time.Millisecond))) > MaxTimeToLive {
		m.TimeToLive = time.Now().Add(MaxTimeToLive).UnixNano() / 1e6
	} else {
		m.TimeToLive = ttl
	}
	return m
}

func (m *Message) SetNotifyID(notifyID int64) *Message {
	m.NotifyID = notifyID
	return m
}

func (m *Message) EnableFlowControl() *Message {
	m.Extra["flow_control"] = "1"
	return m
}

func (m *Message) DisableFlowControl() *Message {
	delete(m.Extra, "flow_control")
	return m
}

// 开发者在发送消息时可以设置消息的组ID（JobKey），带有相同的组ID的消息会被聚合为一个消息组。
// 系统支持按照消息组展示消息详情以及计划推送／送达数量／送达曲线等统计信息。
// 另外，相同JobKey的消息在客户端会进行去重，只展示其中的第一条。
// 这样如果发送时同JobKey中不慎有重复的设备也不用担心用户会收到重复的通知。
func (m *Message) SetJobKey(jobKey string) *Message {
	m.Extra["jobkey"] = jobKey
	return m
}

// 小米推送服务器每隔1s将已送达或已点击的消息ID和对应设备的regid或alias通过调用第三方http接口传给开发者。
func (m *Message) SetCallback(callbackURL string) *Message {
	m.Extra["callback"] = callbackURL
	m.Extra["callback.type"] = "3" // 1:送达回执, 2:点击回执, 3:送达和点击回执
	return m
}

// 添加自定义字段, 客户端使用
func (m *Message) AddExtra(key, value string) *Message {
	m.Extra[key] = value
	return m
}

func (m *Message) JSON() []byte {
	bytes, err := json.Marshal(m)
	if err != nil {
		panic(err)
	}
	return bytes
}

//-----------------------------------------------------------------------------------//
// 发送给Android设备的Message对象
func NewAndroidMessage(title, description string) *Message {
	return &Message{
		Payload:     "",
		Title:       title,
		Description: description,
		PassThrough: 0,
		NotifyType:  -1, // default notify type
		TimeToLive:  0,
		TimeToSend:  0,
		NotifyID:    0,
		Extra:       make(map[string]string),
	}
}

// 打开当前app对应的Launcher Activity。
func (m *Message) SetLauncherActivity() *Message {
	m.Extra["notify_effect"] = "1"
	return m
}

// 打开当前app内的任意一个Activity。
func (m *Message) SetJumpActivity(value string) *Message {
	m.Extra["notify_effect"] = "2"
	m.Extra["intent_uri"] = value
	return m
}

// 打开网页
func (m *Message) SetJumpWebURL(value string) *Message {
	m.Extra["notify_effect"] = "3"
	m.Extra["web_uri"] = value
	return m
}

func (m *Message) SetPayload(payload string) *Message {
	m.Payload = payload
	return m
}

//-----------------------------------------------------------------------------------//
// 发送给IOS设备的Message对象
func NewIOSMessage(description string) *Message {
	return &Message{
		Payload:     "",
		Title:       "",
		Description: description,
		PassThrough: 0,
		NotifyType:  -1, // default notify type
		TimeToLive:  0,
		TimeToSend:  0,
		NotifyID:    0,
		Extra:       make(map[string]string),
	}
}

// 可选项，自定义通知数字角标。
func (i *Message) SetBadge(badge int64) *Message {
	i.Extra["badge"] = strconv.FormatInt(badge, 10)
	return i
}

// 可选项，iOS8推送消息快速回复类别。
func (i *Message) SetCategory(category string) *Message {
	i.Extra["category"] = category
	return i
}

// 可选项，自定义消息铃声。
func (i *Message) SetSoundURL(soundURL string) *Message {
	i.Extra["sound_url"] = soundURL
	return i
}

//-----------------------------------------------------------------------------------//
// TargetedMessage封装了MiPush推送服务系统中的消息Message对象，和该Message对象所要发送到的目标。

type TargetType int32

const (
	TargetTypeRegID   TargetType = 1
	TargetTypeReAlias TargetType = 2
	TargetTypeAccount TargetType = 3
)

type TargetedMessage struct {
	message    *Message
	targetType TargetType
	target     string
}

func NewTargetedMessage(m *Message, target string, targetType TargetType) *TargetedMessage {
	return &TargetedMessage{
		message:    m,
		targetType: targetType,
		target:     target,
	}
}

func (tm *TargetedMessage) SetTargetType(targetType TargetType) *TargetedMessage {
	tm.targetType = targetType
	return tm
}

func (tm *TargetedMessage) SetTarget(target string) *TargetedMessage {
	tm.target = target
	return tm
}

func (tm *TargetedMessage) JSON() []byte {
	bytes, err := json.Marshal(tm)
	if err != nil {
		panic(err)
	}
	return bytes
}