device

Documentation

Index

• Constants
• Variables
• type Service
• type Session

Constants

const (
	ErrorRequireEventID    = "missing required event id"
	ErrorRequireDeviceID   = "missing required device id"
	ErrorRequireUnlockCode = "missing required unlock code"
	ErrorRepository        = "unable to query repository"
	ErrorEventNotFound     = "event not found"
	ErrorUnlockNotFound    = "device / unlock code combination not found"
)

Device Service Error descriptions

const ServiceName = "device"

ServiceName of this service.

Variables

var (
	ErrRequireEventID    = errors.New(ErrorRequireEventID)
	ErrRequireDeviceID   = errors.New(ErrorRequireDeviceID)
	ErrRequireUnlockCode = errors.New(ErrorRequireUnlockCode)
	ErrRepository        = errors.New(ErrorRepository)
	ErrEventNotFound     = errors.New(ErrorEventNotFound)
	ErrUnlockNotFound    = errors.New(ErrorUnlockNotFound)
)

Device Service Errors

Types

type Service

type Service interface {
	Unlock(ctx context.Context, eventID, deviceID uuid.UUID, code string) (*Session, error)
}

Service describes our Device service.

type Session

type Session struct {
	EventCaption  string `json:"event_caption,omitempty"`
	DeviceCaption string `json:"device_caption,omitempty"`
	Token         string `json:"token,omitempty"`
}

Session holds session details