followrequest

Documentation

Index

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

Constants

const (
	// IDKey is for account IDs
	IDKey = "id"
	// BasePath is the base path for serving the follow request API
	BasePath = "/api/v1/follow_requests"
	// BasePathWithID is just the base path with the ID key in it.
	// Use this anywhere you need to know the ID of the account that owns the follow request being queried.
	BasePathWithID = BasePath + "/:" + IDKey
	// AuthorizePath is used for authorizing follow requests
	AuthorizePath = BasePathWithID + "/authorize"
	// RejectPath is used for rejecting follow requests
	RejectPath = BasePathWithID + "/reject"
)

Functions

func New

func New(processor processing.Processor) api.ClientModule

New returns a new follow request module

Types

type Module

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

Module implements the ClientAPIModule interface

func (*Module) FollowRequestAuthorizePOSTHandler

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

FollowRequestAuthorizePOSTHandler swagger:operation POST /api/v1/follow_requests/{account_id}/authorize authorizeFollowRequest

Accept/authorize follow request from the given account ID.

Accept a follow request and put the requesting account in your 'followers' list.

--- tags: - follow_requests

produces: - application/json

parameters:

• name: account_id type: string description: ID of the account requesting to follow you. in: path required: true

security: - OAuth2 Bearer:

• write:follows

responses:

'200':
  name: account relationship
  description: Your relationship to this account.
  schema:
    "$ref": "#/definitions/accountRelationship"
'400':
   description: bad request
'401':
   description: unauthorized
'403':
   description: forbidden
'404':
   description: not found
'500':
   description: internal server error

func (*Module) FollowRequestGETHandler

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

FollowRequestGETHandler swagger:operation GET /api/v1/follow_requests getFollowRequests

Get an array of accounts that have requested to follow you.

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

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

--- tags: - follow_requests

produces: - application/json

parameters:

• name: limit type: integer description: Number of accounts to return. default: 40 in: query

security: - OAuth2 Bearer:

• read:follows

responses:

'200':
  headers:
    Link:
      type: string
      description: Links to the next and previous queries.
  schema:
    type: array
    items:
      "$ref": "#/definitions/account"
'400':
   description: bad request
'401':
   description: unauthorized
'403':
   description: forbidden
'404':
   description: not found

func (*Module) FollowRequestRejectPOSTHandler

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

FollowRequestRejectPOSTHandler swagger:operation POST /api/v1/follow_requests/{account_id}/reject rejectFollowRequest

Reject/deny follow request from the given account ID.

--- tags: - follow_requests

produces: - application/json

parameters:

• name: account_id type: string description: ID of the account requesting to follow you. in: path required: true

security: - OAuth2 Bearer:

• write:follows

responses:

'200':
  name: account relationship
  description: Your relationship to this account.
  schema:
    "$ref": "#/definitions/accountRelationship"
'400':
   description: bad request
'401':
   description: unauthorized
'403':
   description: forbidden
'404':
   description: not found
'500':
   description: internal server error

func (*Module) Route

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

Route attaches all routes from this module to the given router