Documentation ¶
Index ¶
Constants ¶
View Source
const Version = "2.0.0"
Version specifies the client version.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AndroidSetting ¶
type AndroidSetting struct { CollapseKey string `json:"collapse_key,omitempty"` DelayWhileIdle bool `json:"delay_while_idle,omitempty"` TimeToLive int `json:"time_to_live,omitempty"` }
An AndroidSetting has setting fields for FCM/GCM.
type Client ¶
A Client for gaurun server.
type Error ¶
type Error struct { StatusCode int Response gaurun.ResponseGaurun }
An Error is error response from gaurun server.
type IOSSetting ¶
type IOSSetting struct { Title string `json:"title,omitempty"` Subtitle string `json:"subtitle,omitempty"` Badge int `json:"badge,omitempty"` Category string `json:"category,omitempty"` Sound string `json:"sound,omitempty"` ContentAvailable bool `json:"content_available,omitempty"` MutableContent bool `json:"mutable_content,omitempty"` Expiry int `json:"expiry,omitempty"` Retry int `json:"retry,omitempty"` PushType PushType `json:"push_type,omitempty"` }
An IOSSetting has setting fields for APNs.
type Notification ¶
type Notification struct { // Common Tokens []string `json:"token"` Platform Platform `json:"platform"` Message string `json:"message"` Identifier string `json:"identifier,omitempty"` // Android AndroidSetting // iOS IOSSetting // Metadata ID uint64 `json:"seq_id,omitempty"` Extend []*Extend `json:"extend,omitempty"` }
A Notification has gaurun notification data.
type Payload ¶
type Payload struct {
Notifications []*Notification `json:"notifications"`
}
A Payload contains notifications to be sent to gaurun.
type Platform ¶
type Platform int
A Platform is alias gaurun platform enum.
const ( // PlatformAndroid is enum for FCM/GCM. PlatformAndroid Platform = gaurun.PlatFormAndroid // PlatformIOS is enum for APNs. PlatformIOS Platform = gaurun.PlatFormIos )
type PushType ¶
type PushType string
PushType provides enumerated values for the apns-push-type header.
const ( // Use the alert push type for notifications that trigger a user interaction // for example, an alert, badge, or sound. // // The alert push type is required on watchOS 6 and later. // It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeAlert PushType = "alert" // Use the background push type for notifications that deliver content in // the background, and don’t trigger any user interactions. // // The background push type is required on watchOS 6 and later. // It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeBackground PushType = "background" // Use the voip push type for notifications that provide information about // an incoming Voice-over-IP (VoIP) call. // // The voip push type is not available on watchOS. // It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeVoip PushType = "voip" // Use the complication push type for notifications that contain update // information for a watchOS app’s complications. // // The complication push type is recommended for watchOS and iOS. // It is not available on macOS, tvOS, and iPadOS. PushTypeComplication PushType = "complication" // Use the fileprovider push type to signal changes to a File Provider // extension. // // The fileprovider push type is not available on watchOS. // It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeFileProvider PushType = "fileprovider" // Use the mdm push type for notifications that tell managed devices to // contact the MDM server. // // The mdm push type is not available on watchOS. // It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeMdm PushType = "mdm" )
The apns-push-type header field has six valid values. The descriptions below describe when and how to use these values.
Click to show internal directories.
Click to hide internal directories.