favourites

Documentation

Index

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

Constants

const (
	// BasePath is the base URI path for serving favourites, minus the 'api' prefix
	BasePath = "/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"
)

Types

type Module

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

func New

func New(processor *processing.Processor) *Module

func (*Module) FavouritesGETHandler

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

FavouritesGETHandler swagger:operation GET /api/v1/favourites favouritesGet

Get an array of statuses that the requesting account has favourited.

The next and previous queries can be parsed from the returned Link header. Example:

``` <https://example.org/api/v1/favourites?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/favourites?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" ````

---
tags:
- favourites

produces:
- application/json

parameters:
-
	name: limit
	type: integer
	description: Number of statuses to return.
	default: 20
	in: query
-
	name: max_id
	type: string
	description: >-
		Return only favourited statuses *OLDER* than the given favourite ID.
		The status with the corresponding fave ID will not be included in the response.
	in: query
-
	name: min_id
	type: string
	description: >-
		Return only favourited statuses *NEWER* than the given favourite ID.
		The status with the corresponding fave ID will not be included in the response.
	in: query

security:
- OAuth2 Bearer:
	- read:favourites

responses:
	'200':
		headers:
			Link:
				type: string
				description: Links to the next and previous queries.
		schema:
			type: array
			items:
				"$ref": "#/definitions/status"
	'400':
		description: bad request
	'401':
		description: unauthorized
	'404':
		description: not found
	'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)