conversations

package
v0.17.3 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2024 License: AGPL-3.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// BasePath is the base path for serving the conversations API, minus the 'api' prefix.
	BasePath = "/v1/conversations"
	// BasePathWithID is the base path with the ID key in it, for operations on an existing conversation.
	BasePathWithID = BasePath + "/:" + apiutil.IDKey
	// ReadPathWithID is the path for marking an existing conversation as read.
	ReadPathWithID = BasePathWithID + "/read"
)

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) ConversationDELETEHandler added in v0.17.0

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

ConversationDELETEHandler swagger:operation DELETE /api/v1/conversations/{id} conversationDelete

Delete a single conversation with the given ID.

This doesn't delete the actual statuses in the conversation, nor does it prevent a new conversation from being created later from the same thread and participants.

---
tags:
- conversations

produces:
- application/json

parameters:
-
	name: id
	type: string
	description: ID of the conversation
	in: path
	required: true

security:
- OAuth2 Bearer:
	- write:conversations

responses:
	'200':
		description: conversation deleted
	'400':
		description: bad request
	'401':
		description: unauthorized
	'404':
		description: not found
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) ConversationReadPOSTHandler added in v0.17.0

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

ConversationReadPOSTHandler swagger:operation POST /api/v1/conversation/{id}/read conversationRead

Mark a conversation with the given ID as read.

---
tags:
- conversations

produces:
- application/json

parameters:
-
	name: id
	in: path
	type: string
	required: true
	description: ID of the conversation.

security:
- OAuth2 Bearer:
	- write:conversations

responses:
	'200':
		name: conversation
		description: Updated conversation.
		schema:
			"$ref": "#/definitions/conversation"
	'400':
		description: bad request
	'401':
		description: unauthorized
	'404':
		description: not found
	'406':
		description: not acceptable
	'422':
		description: unprocessable content
	'500':
		description: internal server error

func (*Module) ConversationsGETHandler

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

ConversationsGETHandler swagger:operation GET /api/v1/conversations conversationsGet

Get an array of (direct message) conversations that requesting account is involved in.

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

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

---
tags:
- conversations

produces:
- application/json

parameters:
-
	name: max_id
	type: string
	description: >-
		Return only conversations with last statuses *OLDER* than the given max ID.
		The conversation with the specified ID will not be included in the response.
		NOTE: The ID is a status ID. Use the Link header for pagination.
	in: query
	required: false
-
	name: since_id
	type: string
	description: >-
		Return only conversations with last statuses *NEWER* than the given since ID.
		The conversation with the specified ID will not be included in the response.
		NOTE: The ID is a status ID. Use the Link header for pagination.
	in: query
-
	name: min_id
	type: string
	description: >-
		Return only conversations with last statuses *IMMEDIATELY NEWER* than the given min ID.
		The conversation with the specified ID will not be included in the response.
		NOTE: The ID is a status ID. Use the Link header for pagination.
	in: query
	required: false
-
	name: limit
	type: integer
	description: Number of conversations to return.
	default: 40
	minimum: 1
	maximum: 80
	in: query
	required: false

security:
- OAuth2 Bearer:
	- read:statuses

responses:
	'200':
		headers:
			Link:
				type: string
				description: Links to the next and previous queries.
		schema:
			type: array
			items:
				"$ref": "#/definitions/conversation"
	'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)

Jump to

Keyboard shortcuts

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