users

func (*Module) AcceptGETHandler ¶

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

AcceptGETHandler serves an interaction request as an ActivityStreams Accept.

func (*Module) AuthorizationGETHandler ¶ added in v0.20.0

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

AuthorizationGETHandler serves an accepted interaction request as a LikeAuthorization, ReplyAuthorization, or AnnounceAuthorization type.

func (*Module) FeaturedCollectionGETHandler ¶

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

FeaturedCollectionGETHandler swagger:operation GET /users/{username}/collections/featured s2sFeaturedCollectionGet

Get the featured collection (pinned posts) for a user.

The response will contain an ordered collection of Note URIs in the `items` property.

It is up to the caller to dereference the provided Note URIs (or not, if they already have them cached).

HTTP signature is required on the request.

---
tags:
- s2s/federation

produces:
- application/activity+json

parameters:
-
	name: username
	type: string
	description: Account name of the user
	in: path
	required: true

responses:
	'200':
		in: body
		schema:
			"$ref": "#/definitions/swaggerFeaturedCollection"
	'400':
		description: bad request
	'401':
		description: unauthorized
	'403':
		description: forbidden
	'404':
		description: not found

func (*Module) FollowersGETHandler ¶

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

FollowersGETHandler returns a collection of URIs for followers of the target user, formatted so that other AP servers can understand it.

func (*Module) FollowingGETHandler ¶

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

FollowingGETHandler returns a collection of URIs for accounts that the target user follows, formatted so that other AP servers can understand it.

func (*Module) InboxPOSTHandler ¶

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

InboxPOSTHandler deals with incoming POST requests to an actor's inbox. Eg., POST to https://example.org/users/whatever/inbox.

func (*Module) OutboxGETHandler ¶

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

OutboxGETHandler swagger:operation GET /users/{username}/outbox s2sOutboxGet

Get the public outbox collection for an actor.

Note that the response will be a Collection with a page as `first`, as shown below, if `page` is `false`.

If `page` is `true`, then the response will be a single `CollectionPage` without the wrapping `Collection`.

HTTP signature is required on the request.

---
tags:
- s2s/federation

produces:
- application/activity+json

parameters:
-
	name: username
	type: string
	description: Username of the account.
	in: path
	required: true
-
	name: page
	type: boolean
	description: Return response as a CollectionPage.
	in: query
	default: false
-
	name: min_id
	type: string
	description: Minimum ID of the next status, used for paging.
	in: query
-
	name: max_id
	type: string
	description: Maximum ID of the next status, used for paging.
	in: query

responses:
	'200':
		in: body
		schema:
			"$ref": "#/definitions/swaggerCollection"
	'400':
		description: bad request
	'401':
		description: unauthorized
	'403':
		description: forbidden
	'404':
		description: not found

func (*Module) Route ¶

func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes)

func (*Module) StatusGETHandler ¶

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

StatusGETHandler serves the target status as an activitystreams NOTE so that other AP servers can parse it.

func (*Module) StatusRepliesGETHandler ¶

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

StatusRepliesGETHandler swagger:operation GET /users/{username}/statuses/{status}/replies s2sRepliesGet

Get the replies collection for a status.

Note that the response will be a Collection with a page as `first`, as shown below, if `page` is `false`.

If `page` is `true`, then the response will be a single `CollectionPage` without the wrapping `Collection`.

HTTP signature is required on the request.

---
tags:
- s2s/federation

produces:
- application/activity+json

parameters:
-
	name: username
	type: string
	description: Username of the account.
	in: path
	required: true
-
	name: status
	type: string
	description: ID of the status.
	in: path
	required: true
-
	name: page
	type: boolean
	description: Return response as a CollectionPage.
	in: query
	default: false
-
	name: only_other_accounts
	type: boolean
	description: Return replies only from accounts other than the status owner.
	in: query
	default: false
-
	name: min_id
	type: string
	description: Minimum ID of the next status, used for paging.
	in: query

responses:
	'200':
		in: body
		schema:
			"$ref": "#/definitions/swaggerCollection"
	'400':
		description: bad request
	'401':
		description: unauthorized
	'403':
		description: forbidden
	'404':
		description: not found

func (*Module) UsersGETHandler ¶

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

UsersGETHandler should be served at https://example.org/users/:username.

The goal here is to return the activitypub representation of an account in the form of a vocab.ActivityStreamsPerson. This should only be served to REMOTE SERVERS that present a valid signature on the GET request, on behalf of a user, otherwise we risk leaking information about users publicly.

And of course, the request should be refused if the account or server making the request is blocked.