Documentation ¶
Overview ¶
Package apns2 is a go Apple Push Notification Service (APNs) provider that allows you to send remote notifications to your iOS, tvOS, and OS X apps, using the new APNs HTTP/2 network protocol.
Index ¶
Constants ¶
const ( HostDevelopment = "https://api.sandbox.push.apple.com" HostProduction = "https://api.push.apple.com" )
Apple HTTP/2 Development & Production urls
const ( // PriorityLow will tell APNs to send the push message at a time that takes // into account power considerations for the device. Notifications with this // priority might be grouped and delivered in bursts. They are throttled, // and in some cases are not delivered. PriorityLow = 5 // PriorityHigh will tell APNs to send the push message immediately. // Notifications with this priority must trigger an alert, sound, or badge // on the target device. It is an error to use this priority for a push // notification that contains only the content-available key. PriorityHigh = 10 )
const ( // 400 The collapse identifier exceeds the maximum allowed size ReasonBadCollapseID = "BadCollapseId" // 400 The specified device token was bad. Verify that the request contains a // valid token and that the token matches the environment. ReasonBadDeviceToken = "BadDeviceToken" // 400 The apns-expiration value is bad. ReasonBadExpirationDate = "BadExpirationDate" // 400 The apns-id value is bad. ReasonBadMessageID = "BadMessageId" // 400 The apns-priority value is bad. ReasonBadPriority = "BadPriority" // 400 The apns-topic was invalid. ReasonBadTopic = "BadTopic" // 400 The device token does not match the specified topic. ReasonDeviceTokenNotForTopic = "DeviceTokenNotForTopic" // 400 One or more headers were repeated. ReasonDuplicateHeaders = "DuplicateHeaders" // 400 Idle time out. ReasonIdleTimeout = "IdleTimeout" // 400 The apns-push-type value is invalid. ReasonInvalidPushType = "InvalidPushType" // 400 The device token is not specified in the request :path. Verify that the // :path header contains the device token. ReasonMissingDeviceToken = "MissingDeviceToken" // 400 The apns-topic header of the request was not specified and was // required. The apns-topic header is mandatory when the client is connected // using a certificate that supports multiple topics. ReasonMissingTopic = "MissingTopic" // 400 The message payload was empty. ReasonPayloadEmpty = "PayloadEmpty" // 400 Pushing to this topic is not allowed. ReasonTopicDisallowed = "TopicDisallowed" // 403 The certificate was bad. ReasonBadCertificate = "BadCertificate" // 403 The client certificate was for the wrong environment. ReasonBadCertificateEnvironment = "BadCertificateEnvironment" // 403 The provider token is stale and a new token should be generated. ReasonExpiredProviderToken = "ExpiredProviderToken" // 403 The specified action is not allowed. ReasonForbidden = "Forbidden" // 403 The provider token is not valid or the token signature could not be // verified. ReasonInvalidProviderToken = "InvalidProviderToken" // 403 No provider certificate was used to connect to APNs and Authorization // header was missing or no provider token was specified. ReasonMissingProviderToken = "MissingProviderToken" // 404 The request contained a bad :path value. ReasonBadPath = "BadPath" // 405 The specified :method was not POST. ReasonMethodNotAllowed = "MethodNotAllowed" /// 410 The device token has expired. ReasonExpiredToken = "ExpiredToken" // 410 The device token is inactive for the specified topic. ReasonUnregistered = "Unregistered" // 413 The message payload was too large. See Creating the Remote Notification // Payload in the Apple Local and Remote Notification Programming Guide for // details on maximum payload size. ReasonPayloadTooLarge = "PayloadTooLarge" // 429 The provider token is being updated too often. ReasonTooManyProviderTokenUpdates = "TooManyProviderTokenUpdates" // 429 Too many requests were made consecutively to the same device token. ReasonTooManyRequests = "TooManyRequests" // 500 An internal server error occurred. ReasonInternalServerError = "InternalServerError" ReasonServiceUnavailable = "ServiceUnavailable" // 503 The server is shutting down. ReasonShutdown = "Shutdown" )
The possible Reason error codes returned from APNs. From table 4 in the Handling Notification Responses from APNs article
const StatusSent = http.StatusOK
StatusSent is a 200 response.
Variables ¶
var ( // HTTPClientTimeout specifies a time limit for requests made by the // HTTPClient. The timeout includes connection time, any redirects, // and reading the response body. HTTPClientTimeout = 60 * time.Second // ReadIdleTimeout is the timeout after which a health check using a ping // frame will be carried out if no frame is received on the connection. If // zero, no health check is performed. ReadIdleTimeout = 15 * time.Second // TCPKeepAlive specifies the keep-alive period for an active network // connection. If zero, keep-alive probes are sent with a default value // (currently 15 seconds) TCPKeepAlive = 15 * time.Second // TLSDialTimeout is the maximum amount of time a dial will wait for a connect // to complete. TLSDialTimeout = 20 * time.Second )
var DefaultHost = HostDevelopment
DefaultHost is a mutable var for testing purposes
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct { Host string Certificate tls.Certificate Token *token.Token HTTPClient *http.Client }
Client represents a connection with the APNs
func NewClient ¶
func NewClient(certificate tls.Certificate) *Client
NewClient returns a new Client with an underlying http.Client configured with the correct APNs HTTP/2 transport settings. It does not connect to the APNs until the first Notification is sent via the Push method.
As per the Apple APNs Provider API, you should keep a handle on this client so that you can keep your connections with APNs open across multiple notifications; don’t repeatedly open and close connections. APNs treats rapid connection and disconnection as a denial-of-service attack.
If your use case involves multiple long-lived connections, consider using the ClientManager, which manages clients for you.
func NewTokenClient ¶
NewTokenClient returns a new Client with an underlying http.Client configured with the correct APNs HTTP/2 transport settings. It does not connect to the APNs until the first Notification is sent via the Push method.
As per the Apple APNs Provider API, you should keep a handle on this client so that you can keep your connections with APNs open across multiple notifications; don’t repeatedly open and close connections. APNs treats rapid connection and disconnection as a denial-of-service attack.
func (*Client) CloseIdleConnections ¶
func (c *Client) CloseIdleConnections()
CloseIdleConnections closes any underlying connections which were previously connected from previous requests but are now sitting idle. It will not interrupt any connections currently in use.
func (*Client) Development ¶
Development sets the Client to use the APNs development push endpoint.
func (*Client) Production ¶
Production sets the Client to use the APNs production push endpoint.
func (*Client) Push ¶
func (c *Client) Push(n *Notification) (*Response, error)
Push sends a Notification to the APNs gateway. If the underlying http.Client is not currently connected, this method will attempt to reconnect transparently before sending the notification. It will return a Response indicating whether the notification was accepted or rejected by the APNs gateway, or an error if something goes wrong.
Use PushWithContext if you need better cancellation and timeout control.
func (*Client) PushWithContext ¶
PushWithContext sends a Notification to the APNs gateway. Context carries a deadline and a cancellation signal and allows you to close long running requests when the context timeout is exceeded. Context can be nil, for backwards compatibility.
If the underlying http.Client is not currently connected, this method will attempt to reconnect transparently before sending the notification. It will return a Response indicating whether the notification was accepted or rejected by the APNs gateway, or an error if something goes wrong.
type ClientManager ¶
type ClientManager struct { // MaxSize is the maximum number of clients allowed in the manager. When // this limit is reached, the least recently used client is evicted. Set // zero for no limit. MaxSize int // MaxAge is the maximum age of clients in the manager. Upon retrieval, if // a client has remained unused in the manager for this duration or longer, // it is evicted and nil is returned. Set zero to disable this // functionality. MaxAge time.Duration // Factory is the function which constructs clients if not found in the // manager. Factory func(certificate tls.Certificate) *Client // contains filtered or unexported fields }
ClientManager is a way to manage multiple connections to the APNs.
func NewClientManager ¶
func NewClientManager() *ClientManager
NewClientManager returns a new ClientManager for prolonged, concurrent usage of multiple APNs clients. ClientManager is flexible enough to work best for your use case. When a client is not found in the manager, Get will return the result of calling Factory, which can be a Client or nil.
Having multiple clients per certificate in the manager is not allowed.
By default, MaxSize is 64, MaxAge is 10 minutes, and Factory always returns a Client with default options.
func (*ClientManager) Add ¶
func (m *ClientManager) Add(client *Client)
Add adds a Client to the manager. You can use this to individually configure Clients in the manager.
func (*ClientManager) Get ¶
func (m *ClientManager) Get(certificate tls.Certificate) *Client
Get gets a Client from the manager. If a Client is not found in the manager or if a Client has remained in the manager longer than MaxAge, Get will call the ClientManager's Factory function, store the result in the manager if non-nil, and return it.
func (*ClientManager) Len ¶
func (m *ClientManager) Len() int
Len returns the current size of the ClientManager.
type EPushType ¶ added in v0.18.0
type EPushType string
EPushType defines the value for the apns-push-type header
const ( // PushTypeAlert is used for notifications that trigger a user interaction — // for example, an alert, badge, or sound. If you set this push type, the // topic field must use your app’s bundle ID as the topic. If the // notification requires immediate action from the user, set notification // priority to 10; otherwise use 5. The alert push type is required on // watchOS 6 and later. It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeAlert EPushType = "alert" // PushTypeBackground is used for notifications that deliver content in the // background, and don’t trigger any user interactions. If you set this push // type, the topic field must use your app’s bundle ID as the topic. Always // use priority 5. Using priority 10 is an error. The background push type // is required on watchOS 6 and later. It is recommended on macOS, iOS, // tvOS, and iPadOS. PushTypeBackground EPushType = "background" // PushTypeLocation is used for notifications that request a user’s // location. If you set this push type, the topic field must use your app’s // bundle ID with .location-query appended to the end. The location push // type is recommended for iOS and iPadOS. It isn’t available on macOS, // tvOS, and watchOS. If the location query requires an immediate response // from the Location Push Service Extension, set notification apns-priority // to 10; otherwise, use 5. The location push type supports only token-based // authentication. PushTypeLocation EPushType = "location" // PushTypeVOIP is used for notifications that provide information about an // incoming Voice-over-IP (VoIP) call. If you set this push type, the topic // field must use your app’s bundle ID with .voip appended to the end. If // you’re using certificate-based authentication, you must also register the // certificate for VoIP services. The voip push type is not available on // watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS. PushTypeVOIP EPushType = "voip" // PushTypeComplication is used for notifications that contain update // information for a watchOS app’s complications. If you set this push type, // the topic field must use your app’s bundle ID with .complication appended // to the end. If you’re using certificate-based authentication, you must // also register the certificate for WatchKit services. The complication // push type is recommended for watchOS and iOS. It is not available on // macOS, tvOS, and iPadOS. PushTypeComplication EPushType = "complication" // PushTypeFileProvider is used to signal changes to a File Provider // extension. If you set this push type, the topic field must use your app’s // bundle ID with .pushkit.fileprovider appended to the end. The // fileprovider push type is not available on watchOS. It is recommended on // macOS, iOS, tvOS, and iPadOS. PushTypeFileProvider EPushType = "fileprovider" // PushTypeMDM is used for notifications that tell managed devices to // contact the MDM server. If you set this push type, you must use the topic // from the UID attribute in the subject of your MDM push certificate. PushTypeMDM EPushType = "mdm" // PushTypeLiveActivity is used for notifications that send a remote push // notification that updates or ends an ongoing Live Activity. For more // information, see Updating and ending your Live Activity with remote // push notifications[live-activity-push]. // // If you set this push type, the apns-topic header field must use your // app’s bundle ID with the push-type.liveactivity appended to the end. // // [live-activity-push]: https://developer.apple.com/documentation/activitykit/updating-and-ending-your-live-activity-with-activitykit-push-notifications PushTypeLiveActivity EPushType = "liveactivity" )
type Notification ¶
type Notification struct { // An optional canonical UUID that identifies the notification. The // canonical form is 32 lowercase hexadecimal digits, displayed in five // groups separated by hyphens in the form 8-4-4-4-12. An example UUID is as // follows: // // 123e4567-e89b-12d3-a456-42665544000 // // If you don't set this, a new UUID is created by APNs and returned in the // response. ApnsID string // A string which allows multiple notifications with the same collapse // identifier to be displayed to the user as a single notification. The // value should not exceed 64 bytes. CollapseID string // A string containing hexadecimal bytes of the device token for the target // device. DeviceToken string // The topic of the remote notification, which is typically the bundle ID // for your app. The certificate you create in the Apple Developer Member // Center must include the capability for this topic. If your certificate // includes multiple topics, you must specify a value for this header. If // you omit this header and your APNs certificate does not specify multiple // topics, the APNs server uses the certificate’s Subject as the default // topic. Topic string // An optional time at which the notification is no longer valid and can be // discarded by APNs. If this value is in the past, APNs treats the // notification as if it expires immediately and does not store the // notification or attempt to redeliver it. If this value is left as the // default (ie, Expiration.IsZero()) an expiration header will not added to // the http request. Expiration time.Time // The priority of the notification. Specify ether apns.PriorityHigh (10) or // apns.PriorityLow (5) If you don't set this, the APNs server will set the // priority to 10. Priority int // A byte array containing the JSON-encoded payload of this push notification. // Refer to "The Remote Notification Payload" section in the Apple Local and // Remote Notification Programming Guide for more info. Payload any // The pushtype of the push notification. If this values is left as the // default an apns-push-type header with value 'alert' will be added to the // http request. PushType EPushType // An identifier that is only available in the Development environment. // Use this to query Delivery Log information for the corresponding // notification in Push Notifications Console. For more information, see // [Testing notifications using the Push Notification Console](https://developer.apple.com/documentation/usernotifications/testing_notifications_using_the_push_notification_console). ApnsUniqueID string }
Notification represents the data and metadata for a APNs Remote Notification.
func (*Notification) MarshalJSON ¶
func (n *Notification) MarshalJSON() ([]byte, error)
MarshalJSON converts the notification payload to JSON.
type Response ¶
type Response struct { // The HTTP status code returned by APNs. // A 200 value indicates that the notification was successfully sent. // For a list of other possible status codes, see table 6-4 in the Apple Local // and Remote Notification Programming Guide. StatusCode int // The APNs error string indicating the reason for the notification failure (if // any). The error code is specified as a string. For a list of possible // values, see the Reason constants above. // If the notification was accepted, this value will be "". Reason string // The APNs ApnsID value from the Notification. If you didn't set an ApnsID on the // Notification, this will be a new unique UUID which has been created by APNs. ApnsID string // If the value of StatusCode is 410, this is the last time at which APNs // confirmed that the device token was no longer valid for the topic. Timestamp Time // An identifier that is only available in the Development environment. // Use this to query Delivery Log information for the corresponding // notification in Push Notifications Console. For more information, see // [Testing notifications using the Push Notification Console](https://developer.apple.com/documentation/usernotifications/testing_notifications_using_the_push_notification_console). ApnsUniqueID string }
Response represents a result from the APNs gateway indicating whether a notification was accepted or rejected and (if applicable) the metadata surrounding the rejection.
Directories ¶
Path | Synopsis |
---|---|
_example
|
|
Package certificate contains functions to load an Apple APNs PKCS#12 or PEM certificate from either an in memory byte array or a local file.
|
Package certificate contains functions to load an Apple APNs PKCS#12 or PEM certificate from either an in memory byte array or a local file. |
Package payload is a helper package which contains a payload builder to make constructing notification payloads easier.
|
Package payload is a helper package which contains a payload builder to make constructing notification payloads easier. |