timeline

Documentation

Index

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

Constants

const (
	// BasePath is the base URI path for serving timelines
	BasePath = "/api/v1/timelines"
	// HomeTimeline is the path for the home timeline
	HomeTimeline = BasePath + "/home"
	// PublicTimeline is the path for the public (and public local) timeline
	PublicTimeline = BasePath + "/public"
	// 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 timeline module

Types

type Module

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

Module implements the ClientAPIModule interface for everything relating to viewing timelines

func (*Module) HomeTimelineGETHandler

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

HomeTimelineGETHandler swagger:operation GET /api/v1/timelines/home homeTimeline

See statuses/posts by accounts you follow.

The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).

The returned Link header can be used to generate the previous and next queries when scrolling up or down a timeline.

Example:

``` <https://example.org/api/v1/timelines/home?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/home?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev" ````

--- tags: - timelines

produces: - application/json

parameters:

• name: max_id type: string description: |- Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response. in: query required: false
• name: since_id type: string description: |- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query
• name: min_id type: string description: |- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query required: false
• name: limit type: integer description: Number of statuses to return. default: 20 in: query required: false
• name: local type: boolean description: Show only statuses posted by local accounts. default: false in: query required: false

security: - OAuth2 Bearer:

• read:statuses

responses:

'200':
  name: statuses
  description: Array of statuses.
  schema:
    type: array
    items:
      "$ref": "#/definitions/status"
  headers:
    Link:
      type: string
      description: Links to the next and previous queries.
'401':
   description: unauthorized
'400':
   description: bad request

func (*Module) PublicTimelineGETHandler

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

PublicTimelineGETHandler swagger:operation GET /api/v1/timelines/public publicTimeline

See public statuses/posts that your instance is aware of.

The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).

The returned Link header can be used to generate the previous and next queries when scrolling up or down a timeline.

Example:

``` <https://example.org/api/v1/timelines/public?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/public?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev" ````

--- tags: - timelines

produces: - application/json

parameters:

• name: max_id type: string description: |- Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response. in: query required: false
• name: since_id type: string description: |- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query
• name: min_id type: string description: |- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query required: false
• name: limit type: integer description: Number of statuses to return. default: 20 in: query required: false
• name: local type: boolean description: Show only statuses posted by local accounts. default: false in: query required: false

security: - OAuth2 Bearer:

• read:statuses

responses:

'200':
  name: statuses
  description: Array of statuses.
  schema:
    type: array
    items:
      "$ref": "#/definitions/status"
  headers:
    Link:
      type: string
      description: Links to the next and previous queries.
'401':
   description: unauthorized
'400':
   description: bad request

func (*Module) Route

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

Route attaches all routes from this module to the given router