push

Documentation

Index

• Variables
• type Record
  • func (r *Record) Clone() *Record
  • func (r *Record) CopyTo(dst *Record)
  • func (r *Record) Validate() error
• type Store
• type TokenType

Variables

var (
	ErrTokenExists   = errors.New("push token already exists")
	ErrTokenNotFound = errors.New("push token not found for data container")
)

Types

type Record

type Record struct {
	Id uint64

	DataContainerId user.DataContainerID

	PushToken string
	TokenType TokenType
	IsValid   bool

	AppInstallId *string

	CreatedAt time.Time
}

func (*Record) Clone

func (r *Record) Clone() *Record

func (*Record) CopyTo

func (r *Record) CopyTo(dst *Record)

func (*Record) Validate

func (r *Record) Validate() error

type Store

type Store interface {
	// Put creates a new push token record
	Put(ctx context.Context, record *Record) error

	// MarkAsInvalid marks all entries with the push token as invalid
	MarkAsInvalid(ctx context.Context, pushToken string) error

	// Delete deletes all entries with the push token
	Delete(ctx context.Context, pushToken string) error

	// GetAllValidByDataContainer gets all valid push token records for a given
	// data container.
	GetAllValidByDataContainer(ctx context.Context, id *user.DataContainerID) ([]*Record, error)
}

type TokenType

type TokenType uint8

const (
	TokenTypeUnknown TokenType = iota
	TokenTypeFcmAndroid
	TokenTypeFcmApns
)