API-Referenz

Chat

Funktionsunterstützung über app.capabilities prüfen, Autorisierung über app.access und Host-Berechtigungen. Die Beispiele verwenden synthetische Werte; vor dem Aufruf Pfade, IDs, Eingaben und Filter ersetzen.

Typdefinitionen

graphql
type Mutation {
  deleteChatItem(id: ID!): Boolean!
  deleteChatItems(query: String!): ActionResult!
  editChatText(id: ID!, text: String!): ChatTextEdit!
  forwardChatItems(id: ID!, targets: [String!]!, note: String): [ChatItem!]!
  retryChatItem(id: ID!, recipientIds: [ID!]): ChatItem!
  sendChatItems(targets: [String!]!, content: ChatContentInput!): [ChatItem!]!
  sendFolderShare(targets: [String!]!, path: String!, name: String!, expiresAt: Instant): [ChatItem!]!
  sendShare(targets: [String!]!, shareId: ID!): [ChatItem!]!
}

type Query {
  chatConversations: [ChatConversation!]!
  chatCount(query: String!): Int!
  chatItem(id: ID!): ChatItem
  chatItems(target: String!, query: String!, offset: Int!, limit: Int!): [ChatItem!]!
  chatRecords(query: String!, offset: Int!, limit: Int!): [ChatItem!]!
}

type Subscription {
  messagesCreated: [ChatItem!]!
  messagesUpdated: [ChatItem!]!
  messagesDeleted: String!
}

type ActionResult {
	affectedCount: Int!
}

type ChatAttachment {
	id: ID!
	uri: String!
	size: Long!
	durationMs: Long!
	width: Int!
	height: Int!
	summary: String!
	fileName: String!
}

input ChatAttachmentInput {
	id: ID!
	uri: String!
	size: Long!
	durationMs: Long! = 0
	width: Int! = 0
	height: Int! = 0
	summary: String! = ""
	fileName: String! = ""
}

enum ChatAttachmentType {
	IMAGE
	FILE
}

union ChatContent = ChatMessageContent | ChatShareContent

input ChatContentInput @oneOf {
	message: ChatMessageInput
	share: ChatShareInput
}

type ChatConversation {
	id: ID!
	chat: ChatItem!
}

type ChatDeliveryResult {
	peerId: ID!
	peerName: String!
	error: String
}

type ChatItem {
	
	fromId: ID!
	
	toId: ID!
	
	channelId: ID
	id: ID!
	content: ChatContent!
	createdAt: Instant!
	updatedAt: Instant!
	status: ChatStatus!
	deliveryResults: [ChatDeliveryResult!]!
}

type ChatLinkPreview {
	url: String!
	title: String
	description: String
	image: String
	imageWidth: Int!
	imageHeight: Int!
	siteName: String
	domain: String
	createdAt: Instant!
}

type ChatMessageAttachment {
	type: ChatAttachmentType!
	attachment: ChatAttachment!
}

input ChatMessageAttachmentInput {
	type: ChatAttachmentType!
	attachment: ChatAttachmentInput!
}

type ChatMessageContent {
	text: String
	format: ChatTextFormat!
	items: [ChatMessageAttachment!]!
	linkPreviews: [ChatLinkPreview!]!
}

input ChatMessageInput {
	text: String
	format: ChatTextFormat! = PLAIN
	items: [ChatMessageAttachmentInput!]! = []
}

type ChatShareContent {
	shareId: ID!
	urlToken: String!
	peerInfo: ChatSharePeer!
	name: String!
	itemCount: Long!
	totalSize: Long!
	expiresAt: Instant
}

input ChatShareInput {
	shareId: ID!
	urlToken: String!
	peerInfo: ChatSharePeerInput!
	name: String!
	itemCount: Long! = 0
	totalSize: Long! = 0
	expiresAt: Instant
}

type ChatSharePeer {
	id: ID!
	ip: String!
	port: Int!
}

input ChatSharePeerInput {
	id: ID!
	ip: String!
	port: Int!
}

enum ChatStatus {
	SENT
	FAILED
	PARTIAL
	PENDING
}

type ChatTextEdit {
	changed: Boolean!
	chat: ChatItem!
}

enum ChatTextFormat {
	PLAIN
	MARKDOWN
}

scalar Instant

scalar Long

Operationen

mutation

deleteChatItem

Löscht eine Chatnachricht anhand ihrer ID.

graphql
# Always true: an id that is already gone is the state the caller asked
# for, and the contract has no way to say "nothing was there".
mutation deleteChatItem($id: ID!) {
  deleteChatItem(id: $id)
}
mutation

deleteChatItems

Löscht Chatnachrichten, die einer Abfrage entsprechen, gesammelt, etwa mit "id:msg_x,id:msg_y".

graphql
mutation deleteChatItems($query: String!) {
  deleteChatItems(query: $query) { affectedCount }
}
mutation

editChatText

Ändert den Text einer vorhandenen Chatnachricht und gibt das Bearbeitungsergebnis zurück.

graphql
mutation editChatText($id: ID!, $text: String!) {
  editChatText(id: $id, text: $text) { changed }
}
mutation

forwardChatItems

Leitet den ursprünglichen Inhalt unverändert weiter und sendet die optionale Notiz anschließend für jedes Ziel als separate Klartextnachricht. Jedes zurückgegebene Element hat einen eigenen Zustellstatus.

graphql
mutation forwardChatItems($id: ID!, $targets: [String!]!, $note: String) {
  forwardChatItems(id: $id, targets: $targets, note: $note) { id status deliveryResults { peerId peerName error } content { __typename ... on ChatMessageContent { text format } } }
}
mutation

retryChatItem

Versucht den Versand erneut. Empfänger können nur bei Kanalnachrichten angegeben werden.

graphql
mutation retryChatItem($id: ID!, $recipientIds: [ID!]) {
  retryChatItem(id: $id, recipientIds: $recipientIds) { fromId toId channelId id createdAt updatedAt status }
}
mutation

sendChatItems

Sendet eine Nachricht an ein oder mehrere Ziele mit peer:example-id oder channel:example-id.

graphql
mutation sendChatItems($targets: [String!]!, $content: ChatContentInput!) {
  sendChatItems(targets: $targets, content: $content) { fromId toId channelId id createdAt updatedAt status }
}
mutation

sendFolderShare

Erstellt eine Ordnerfreigabe und sendet deren Freigabekarte an die ausgewählten Chatziele.

graphql
mutation sendFolderShare($targets: [String!]!, $path: String!, $name: String!, $expiresAt: Instant) {
  sendFolderShare(targets: $targets, path: $path, name: $name, expiresAt: $expiresAt) { fromId toId channelId id createdAt updatedAt status }
}
mutation

sendShare

Sendet die Karte einer vorhandenen Freigabe an die ausgewählten Chatziele.

graphql
mutation sendShare($targets: [String!]!, $shareId: ID!) {
  sendShare(targets: $targets, shareId: $shareId) { fromId toId channelId id createdAt updatedAt status }
}
query

chatConversations

Listet Chatkonversationen mit einer Zusammenfassung der jeweils neuesten Nachricht auf.

graphql
query chatConversations {
  chatConversations { id }
}
query

chatCount

Zählt gespeicherte Chatnachrichten, die der Abfrage entsprechen.

graphql
query chatCount($query: String!) {
  chatCount(query: $query)
}
query

chatItem

Liest eine gespeicherte Chatnachricht anhand ihrer ID; gibt null zurück, wenn sie fehlt.

graphql
query chatItem($id: ID!) {
  chatItem(id: $id) { fromId toId channelId id createdAt updatedAt status }
}
query

chatItems

Liest alle Nachrichten einer Konversation. Der id das Präfix channel: oder peer: voranstellen.

graphql
# Messages in chronological order; `target`: `peer:<id>` or `channel:<id>`.
query chatItems($target: String!, $query: String!, $offset: Int!, $limit: Int!) {
  chatItems(target: $target, query: $query, offset: $offset, limit: $limit) { fromId toId channelId id createdAt updatedAt status }
}
query

chatRecords

Durchsucht gespeicherte Chatnachrichten mit Seitennavigation.

graphql
query chatRecords($query: String!, $offset: Int!, $limit: Int!) {
  chatRecords(query: $query, offset: $offset, limit: $limit) { fromId toId channelId id createdAt updatedAt status }
}
subscription

messagesCreated

Empfängt neu gespeicherte Chatnachrichten.

graphql
subscription messagesCreated {
  messagesCreated { fromId toId channelId id createdAt updatedAt status }
}
subscription

messagesUpdated

Empfängt Aktualisierungen gespeicherter Chatnachrichten.

graphql
subscription messagesUpdated {
  messagesUpdated { fromId toId channelId id createdAt updatedAt status }
}
subscription

messagesDeleted

Empfängt eine Benachrichtigung über gelöschte Chatnachrichten.

graphql
subscription messagesDeleted {
  messagesDeleted
}