mutes

Documentation

Index

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

Constants

const (
	// BasePath is the base URI path for serving mutes, minus the api prefix.
	BasePath = "/v1/mutes"
)

Types

type Module

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

func New

func New(processor *processing.Processor) *Module

func (*Module) MutesGETHandler

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

MutesGETHandler swagger:operation GET /api/v1/mutes mutesGet

Get an array of accounts that requesting account has muted.

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

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

---
tags:
- mutes

produces:
- application/json

parameters:
-
	name: max_id
	type: string
	description: >-
		Return only muted accounts *OLDER* than the given max ID.
		The muted account with the specified ID will not be included in the response.
		NOTE: the ID is of the internal mute, NOT any of the returned accounts.
	in: query
	required: false
-
	name: since_id
	type: string
	description: >-
		Return only muted accounts *NEWER* than the given since ID.
		The muted account with the specified ID will not be included in the response.
		NOTE: the ID is of the internal mute, NOT any of the returned accounts.
	in: query
-
	name: min_id
	type: string
	description: >-
		Return only muted accounts *IMMEDIATELY NEWER* than the given min ID.
		The muted account with the specified ID will not be included in the response.
		NOTE: the ID is of the internal mute, NOT any of the returned accounts.
	in: query
	required: false
-
	name: limit
	type: integer
	description: Number of muted accounts to return.
	default: 40
	minimum: 1
	maximum: 80
	in: query
	required: false

security:
- OAuth2 Bearer:
	- read:mutes

responses:
	'200':
		description: List of muted accounts, including when their mutes expire (if applicable).
		headers:
			Link:
				type: string
				description: Links to the next and previous queries.
		schema:
			type: array
			items:
				"$ref": "#/definitions/mutedAccount"
	'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)