favourites

Documentation

Index

• Constants
• func New(processor processing.Processor) api.ClientModule
• type Module
  • func (m *Module) FavouritesGETHandler(c *gin.Context)
  • func (m *Module) Route(r router.Router) error

Constants

const (
	// BasePath is the base URI path for serving favourites
	BasePath = "/api/v1/favourites"

	// MaxIDKey is the url query for setting a max status ID to return
	MaxIDKey = "max_id"
	// SinceIDKey is the url query for returning results newer than the given ID
	SinceIDKey = "since_id"
	// MinIDKey is the url query for returning results immediately newer than the given ID
	MinIDKey = "min_id"
	// LimitKey is for specifying maximum number of results to return.
	LimitKey = "limit"
	// LocalKey is for specifying whether only local statuses should be returned
	LocalKey = "local"
)

Functions

func New

func New(processor processing.Processor) api.ClientModule

New returns a new favourites module

Types

type Module

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

Module implements the ClientAPIModule interface for everything relating to viewing favourites

func (*Module) FavouritesGETHandler

func (m *Module) FavouritesGETHandler(c *gin.Context)

FavouritesGETHandler handles GETting favourites.

func (*Module) Route

func (m *Module) Route(r router.Router) error

Route attaches all routes from this module to the given router