push

README

xiaomi-go-sdk-push

xiaomi push service sdk, in golang

It's a golang sdk for xiaomi push. Refer to example/main.go for usage.

Documentation

Index

• type Client
  • func NewClient(appSecret string) *Client
  • func (c Client) SendRequest(r *Request) (string, error)
• type Request

Types

type Client

type Client struct {
	AppSecret string
}

Client is used to send push request.

func NewClient

func NewClient(appSecret string) *Client

NewClient function construct a new Client.

func (Client) SendRequest

func (c Client) SendRequest(r *Request) (string, error)

SendRequest method sends out a PushRequest.

type Request

type Request struct {
	// push target
	TargetType            string //all, regid, alias, user_account, topic, multi_topic
	TargetValue           string
	RestrictedPackageName string

	// push configuration
	Title       string
	Description string
	Payload     string

	// IOS specific
	ExtraBadge    int
	ExtraCategory int

	// Android specific
	PassThrough           int
	NotifyType            int
	NotifyID              int
	ExtraSourceURI        string
	ExtraTicker           string
	ExtraNotifyForeground int
	ExtraNotifyEffect     int
	ExtraIntentURI        string
	ExtraWebURI           string
	ExtraFlowControl      int
	ExtraLayoutName       string
	ExtraLayoutValue      string
	ExtraJobkey           string
	ExtraCallback         string
	ExtraLocale           string
	ExtraLocaleNotIn      string
	ExtraModel            string
	ExtraModelNotIn       string
	ExtraAppVersion       string
	ExtraAppVersionNotIn  string
	ExtraConnpt           string

	// Message control
	TimeToSend   int // milliseconds since 1970.1.1 00:00:00 UTC
	TimeToLive   int // milliseconds to keep message
	StoreOffline bool
	ExpireTime   string
	BatchNumber  string
}

PushRequest struct represents a message to be pushed to mobile.