exports

package
v0.20.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2025 License: AGPL-3.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	BasePath      = "/v1/exports"
	StatsPath     = BasePath + "/stats"
	FollowingPath = BasePath + "/following.csv"
	FollowersPath = BasePath + "/followers.csv"
	ListsPath     = BasePath + "/lists.csv"
	BlocksPath    = BasePath + "/blocks.csv"
	MutesPath     = BasePath + "/mutes.csv"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Module

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

func New

func New(processor *processing.Processor) *Module

func (*Module) ExportBlocksGETHandler

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

ExportBlocksGETHandler swagger:operation GET /api/v1/exports/blocks.csv exportBlocks

Export a CSV file of accounts that you block.

---
tags:
- import-export

produces:
- text/csv

security:
- OAuth2 Bearer:
	- read:blocks

responses:
	'200':
		name: accounts
		description: CSV file of accounts that you block.
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) ExportFollowersGETHandler

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

ExportFollowersGETHandler swagger:operation GET /api/v1/exports/followers.csv exportFollowers

Export a CSV file of accounts that follow you.

---
tags:
- import-export

produces:
- text/csv

security:
- OAuth2 Bearer:
	- read:accounts

responses:
	'200':
		name: accounts
		description: CSV file of accounts that follow you.
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) ExportFollowingGETHandler

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

ExportFollowingGETHandler swagger:operation GET /api/v1/exports/following.csv exportFollowing

Export a CSV file of accounts that you follow.

---
tags:
- import-export

produces:
- text/csv

security:
- OAuth2 Bearer:
	- read:follows

responses:
	'200':
		name: accounts
		description: CSV file of accounts that you follow.
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) ExportListsGETHandler

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

ExportListsGETHandler swagger:operation GET /api/v1/exports/lists.csv exportLists

Export a CSV file of lists created by you.

---
tags:
- import-export

produces:
- text/csv

security:
- OAuth2 Bearer:
	- read:lists

responses:
	'200':
		name: accounts
		description: CSV file of lists.
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) ExportMutesGETHandler

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

ExportMutesGETHandler swagger:operation GET /api/v1/exports/mutes.csv exportMutes

Export a CSV file of accounts that you mute.

---
tags:
- import-export

produces:
- text/csv

security:
- OAuth2 Bearer:
	- read:mutes

responses:
	'200':
		name: accounts
		description: CSV file of accounts that you mute.
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) ExportStatsGETHandler

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

ExportStatsGETHandler swagger:operation GET /api/v1/exports/stats exportStats

Returns informational stats on the number of items that can be exported for requesting account.

---
tags:
- import-export

produces:
- application/json

security:
- OAuth2 Bearer:
	- read:accounts

responses:
	'200':
		description: Export stats for the requesting account.
		schema:
			"$ref": "#/definitions/accountExportStats"
	'401':
		description: unauthorized
	'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)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL