bookmarks

Documentation

Index

• Constants
• type Module
  • func New(processor *processing.Processor) *Module
  • func (m *Module) BookmarksGETHandler(c *gin.Context)
  • func (m *Module) Route(...)

Constants

const (
	// LimitKey is for setting the return amount limit for eg., requesting an account's statuses
	LimitKey = "limit"

	// MaxIDKey is for specifying the maximum ID of the bookmark to retrieve.
	MaxIDKey = "max_id"
	// MinIDKey is for specifying the minimum ID of the bookmark to retrieve.
	MinIDKey = "min_id"
)

const (
	// BasePath is the base path for serving the bookmarks API, minus the 'api' prefix
	BasePath = "/v1/bookmarks"
)

Types

type Module

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

func New

func New(processor *processing.Processor) *Module

func (*Module) BookmarksGETHandler

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

BookmarksGETHandler swagger:operation GET /api/v1/bookmarks bookmarksGet

Get an array of statuses bookmarked in the instance

---
tags:
- bookmarks

produces:
- application/json

security:
- OAuth2 Bearer:
	- read:bookmarks

responses:
	'200':
		description: Array of bookmarked statuses
		schema:
			type: array
			items:
				"$ref": "#/definitions/status"
		headers:
			Link:
				type: string
				description: Links to the next and previous queries.
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) Route

func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes)