preferences

Documentation

Index

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

Constants

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

Types

type Module

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

func New

func New(processor *processing.Processor) *Module

func (*Module) PreferencesGETHandler

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

PreferencesGETHandler swagger:operation GET /api/v1/preferences preferencesGet

Return an object of user preferences.

Example:

```

{
	 "posting:default:visibility": "public",
	 "posting:default:sensitive": false,
	 "posting:default:language": "en",
	 "reading:expand:media": "default",
	 "reading:expand:spoilers": false,
	 "reading:autoplay:gifs": false
}

````

---
tags:
- preferences

produces:
- application/json

security:
- OAuth2 Bearer:
	- read:accounts

responses:
	'200':
		schema:
			type: object
	'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)