fcm

May 31, 2024

Changes in this version

type Option

+ func WithCustomClientOption(opts ...option.ClientOption) Option

May 25, 2024

Changes in this version

type Option

+ func WithDebug(debug bool) Option

May 25, 2024

Changes in this version

type Client

+ func (c *Client) SendDryRun(ctx context.Context, message ...*messaging.Message) (*messaging.BatchResponse, error)

+ func (c *Client) SendMulticast(ctx context.Context, message *messaging.MulticastMessage) (*messaging.BatchResponse, error)

+ func (c *Client) SendMulticastDryRun(ctx context.Context, message *messaging.MulticastMessage) (*messaging.BatchResponse, error)

+ func (c *Client) SubscribeTopic(ctx context.Context, tokens []string, topic string) (*messaging.TopicManagementResponse, error)

+ func (c *Client) UnsubscribeTopic(ctx context.Context, tokens []string, topic string) (*messaging.TopicManagementResponse, error)

type Option

+ func WithCredentialsFile(filename string) Option

+ func WithCredentialsJSON(json []byte) Option

+ func WithProjectID(projectID string) Option

+ func WithServiceAccount(serviceAccount string) Option

+ func WithTokenSource(s oauth2.TokenSource) Option

Jan 31, 2024

Changes in this version

type Client

+ func (c *Client) SendWithRetryWithContext(ctx context.Context, msg *Message, retryAttempts int) (*Response, error)

type Option

+ func WithHTTPProxy(proxyURL string) Option

type Response

+ ErrorResponseCode string

type Result

+ ErrorResponseCode string

Jan 31, 2020

Changes in this version

type Client

+ func (c *Client) SendWithContext(ctx context.Context, msg *Message) (*Response, error)

type Message

+ Apns map[string]interface{}

+ Webpush map[string]interface{}

type Notification

+ Image string

Jun 1, 2019

Changes in this version

+ const DefaultEndpoint

+ const DefaultTimeout

+ var ErrDeviceMessageRateExceeded = errors.New("device message rate exceeded")

+ var ErrInternalServerError = serverError("internal server error")

+ var ErrInvalidAPIKey = errors.New("client API Key is invalid")

+ var ErrInvalidApnsCredential = errors.New("invalid APNs credentials")

+ var ErrInvalidDataKey = errors.New("invalid data key")

+ var ErrInvalidMessage = errors.New("message is invalid")

+ var ErrInvalidPackageName = errors.New("invalid package name")

+ var ErrInvalidParameters = errors.New("check that the provided parameters have the right name and type")

+ var ErrInvalidRegistration = errors.New("invalid registration token")

+ var ErrInvalidTTL = errors.New("invalid time to live")

+ var ErrInvalidTarget = errors.New("topic is invalid or registration ids are not set")

+ var ErrInvalidTimeToLive = errors.New("messages time-to-live is invalid")

+ var ErrMessageTooBig = errors.New("message is too big")

+ var ErrMismatchSenderID = errors.New("mismatched sender id")

+ var ErrMissingRegistration = errors.New("missing registration token")

+ var ErrNotRegistered = errors.New("unregistered device")

+ var ErrToManyRegIDs = errors.New("too many registrations ids")

+ var ErrTopicsMessageRateExceeded = errors.New("topics message rate exceeded")

+ var ErrUnavailable = connectionError("timeout")

+ var ErrUnknown = errors.New("unknown error type")

+ type Client struct

+ func NewClient(apiKey string, opts ...Option) (*Client, error)

+ func (c *Client) Send(msg *Message) (*Response, error)

+ func (c *Client) SendWithRetry(msg *Message, retryAttempts int) (*Response, error)

+ type Message struct

+ CollapseKey string

+ Condition string

+ ContentAvailable bool

+ Data map[string]interface{}

+ DelayWhileIdle bool

+ DeliveryReceiptRequested bool

+ DryRun bool

+ MutableContent bool

+ Notification *Notification

+ Priority string

+ RegistrationIDs []string

+ RestrictedPackageName string

+ TimeToLive *uint

+ To string

+ func (msg *Message) Validate() error

+ type Notification struct

+ Badge string

+ Body string

+ BodyLocArgs string

+ BodyLocKey string

+ ChannelID string

+ ClickAction string

+ Color string

+ Icon string

+ Sound string

+ Tag string

+ Title string

+ TitleLocArgs string

+ TitleLocKey string

+ type Option func(*Client) error

+ func WithEndpoint(endpoint string) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithTimeout(d time.Duration) Option

+ type Response struct

+ CanonicalIDs int

+ Error error

+ FailedRegistrationIDs []string

+ Failure int

+ MessageID int64

+ MulticastID int64

+ Results []Result

+ Success int

+ func (r *Response) UnmarshalJSON(data []byte) error

+ type Result struct

+ Error error

+ MessageID string

+ RegistrationID string

+ func (r *Result) UnmarshalJSON(data []byte) error

+ func (r Result) Unregistered() bool