vkpns

README

vkpns

Sending VKPNS messages with golang.

Documentation

Index

• Constants
• Variables
• type Android
• type AndroidNotification
• type Client
  • func NewClient(ctx context.Context, options ClientOptions) (*Client, error)
  • func (c *Client) Send(ctx context.Context, message *Push) (*Response, error)
  • func (c *Client) SendDryRun(ctx context.Context, message *Push) (*Response, error)
• type ClientOptions
• type Message
• type Notification
• type Push
• type Response

Constants

const (
	ErrInvalid   = "INVALID_ARGUMENT"  // неправильно указаны параметры запроса при отправке сообщения.
	ErrInternal  = "INTERNAL"          // внутренняя ошибка сервиса.
	ErrRatelimit = "TOO_MANY_REQUESTS" // превышено количество попыток отправить сообщение.
	ErrDenied    = "PERMISSION_DENIED" // неправильно указан сервисный ключ.
	ErrNotFound  = "NOT_FOUND"         // неправильно указан push-токен пользователя.
)

Variables

var (
	ErrNoData         = errors.New("no data to access VKPNS")
	ErrNotImplemented = errors.New("method is not implemented")
	ErrNoMessage      = errors.New("нет сообщения для отправки")
)

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 DialTLS = func(network, addr string, cfg *tls.Config) (net.Conn, error) {
	dialer := &net.Dialer{
		Timeout:   TLSDialTimeout,
		KeepAlive: TCPKeepAlive,
	}
	return tls.DialWithDialer(dialer, network, addr, cfg)
}

DialTLS is the default dial function for creating TLS connections for non-proxied HTTPS requests.

Types

type Android

type Android struct {
	TTL          string              `json:"ttl,omitempty"`          // Как долго (в секундах) сообщение должно храниться в хранилище. Пример: 3.5s.
	Notification AndroidNotification `json:"notification,omitempty"` // Уведомление для отправки на устройства Android.
}

type AndroidNotification

type AndroidNotification struct {
	Title           string `json:"title,omitempty"`             // Название уведомления.
	Body            string `json:"body,omitempty"`              // Основной текст уведомления.
	Icon            string `json:"icon,omitempty"`              // Значок уведомления..
	Color           string `json:"color,omitempty"`             // Цвет значка уведомления в формате #rrggbb.
	Image           string `json:"image,omitempty"`             // Содержит URL-адрес изображения, которое будет отображаться в уведомлении.
	ChannelID       string `json:"channel_id,omitempty"`        // Идентификатор канала уведомления.
	ClickAction     string `json:"click_action,omitempty"`      // Действие, связанное с кликом пользователя по уведомлению.
	ClickActionType int    `json:"click_action_type,omitempty"` // Необязательное поле, тип click_action (значение по умолчанию 0 - click_action будет использоваться как intent action, 1 - click_action будет использоваться как deep link).
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, options ClientOptions) (*Client, error)

NewClient creates a new instance of the VKPNS client.

func (*Client) Send

func (c *Client) Send(ctx context.Context, message *Push) (*Response, error)

Send sends a Notification to the VKPNs 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.

It will return a Response indicating whether the notification was accepted or rejected by the VKPNs gateway, or an error if something goes wrong.

func (*Client) SendDryRun

func (c *Client) SendDryRun(ctx context.Context, message *Push) (*Response, error)

type ClientOptions

type ClientOptions struct {
	ProjectID     string
	ServiceToken  string
	VKPNSEndpoint string
}

type Message

type Message struct {
	Token        string            `json:"token"`                  // Push-токен пользователя, полученный в приложении.
	Data         map[string]string `json:"data,omitempty"`         // Объект, содержащий пары "key": value.
	Notification Notification      `json:"notification,omitempty"` // Базовый шаблон уведомления для использования на всех платформах.
	Android      Android           `json:"android,omitempty"`      // Специальные параметры Android для сообщений.
}

Структура push-уведомления.

type Notification

type Notification struct {
	Title string `json:"title,omitempty"` // Название уведомления.
	Body  string `json:"body,omitempty"`  // Основной текст уведомления.
	Image string `json:"image,omitempty"` // Содержит URL-адрес изображения, которое будет отображаться в уведомлении.
}

type Push

type Push struct {
	Message Message `json:"message"`
}

Push - модель для запроса на отправку сообщения.

type Response

type Response struct {
	Code    int    `json:"code"`    // Числовой код ошибки.
	Message string `json:"message"` // Детальное описание ошибки.
	Status  string `json:"status"`  // Код ошибки в текстовом формате.
}

Response - ответ сервиса.