PlainApp
API-Referenz

Chat

Lokale Chat-Nachrichten, Kanäle und gekoppelte Peers verwalten. Alle GraphQL-Operationen werden an POST /graphql gesendet.

Typdefinitionen

bash
type ChatItem {
  id: ID!
  fromId: String!      # "me" | peerId
  toId: String!        # peerId (direct) | "" (channel)
  channelId: String!   # "" for direct messages
  content: String!     # JSON-encoded message payload
  createdAt: String!   # ISO 8601
  updatedAt: String!
  status: String!      # "sent" | "pending" | "failed"
  statusData: String!  # extra info on failure
}

type ChatChannel {
  id: String!
  name: String!
  owner: String!             # "me" | peerId
  members: [ChatChannelMember!]!
  version: Int!
  status: String!            # "active" | "left"
  createdAt: String!
  updatedAt: String!
}

type ChatChannelMember {
  id: String!
  status: String!            # "active" | "pending"
}

type Peer {
  id: String!
  name: String!
  ip: String!
  status: String!            # "online" | "offline"
  port: Int!
  deviceType: String!        # "phone" | "tablet" | "pc"
  createdAt: String!
  updatedAt: String!
}

type AppFile {
  id: ID!
  size: Int!                 # bytes
  mimeType: String!
  realPath: String!
  fileName: String!
  createdAt: String!
  updatedAt: String!
}

Operationen

query

chatItems

Alle Nachrichten einer Konversation abrufen. Der ID das Präfix "channel:" oder "peer:" voranstellen.

bash
query GetChatItems($id: String!) {
  chatItems(id: $id) {
    id fromId toId channelId
    content createdAt updatedAt status statusData
  }
}
query

latestChatItems

Die letzte Nachricht aus jeder Konversation (Kanäle + Peers) abrufen. Nützlich für eine Konversationslisten-Vorschau.

bash
query GetLatestChatItems {
  latestChatItems {
    id fromId toId channelId content createdAt updatedAt status
  }
}
query

chatChannels

Alle Chat-Kanäle auflisten, die dem Gerät gehören oder von ihm beigetreten wurden.

bash
query GetChatChannels {
  chatChannels {
    id name owner version status createdAt updatedAt
    members { id status }
  }
}
query

peers

Alle bekannten Peers auflisten, die mit diesem Gerät gekoppelt sind.

bash
query GetPeers {
  peers { id name ip status port deviceType createdAt updatedAt }
}
mutation

deletePeer

Einen Peer-Eintrag von diesem Gerät löschen. Entkoppelt nicht auf der Remote-Seite; für eine saubere beidseitige Entkopplung unpairPeer verwenden.

bash
mutation DeletePeer($id: ID!) {
  deletePeer(id: $id)
}
mutation

unpairPeer

Ein Peer-Gerät entkoppeln. Löscht den Kopplungszustand auf diesem Gerät und signalisiert dem Remote-Peer, wenn erreichbar.

bash
mutation UnpairPeer($id: ID!) {
  unpairPeer(id: $id)
}
query

appFiles

Paginierte Liste der über Chat geteilten Dateien.

bash
query GetAppFiles($offset: Int!, $limit: Int!) {
  appFiles(offset: $offset, limit: $limit) {
    id size mimeType realPath fileName createdAt updatedAt
  }
}
query

appFileCount

Gesamtanzahl der über Chat geteilten Dateien.

bash
query GetAppFileCount {
  appFileCount
}
mutation

sendChatItem

Eine Nachricht an einen Kanal oder Peer senden. toId-Format: "channel:<id>" oder "peer:<id>".

bash
mutation SendChatItem($toId: String!, $content: String!) {
  sendChatItem(toId: $toId, content: $content) {
    id fromId toId channelId content createdAt updatedAt status
  }
}
mutation

deleteChatItem

Eine Chat-Nachricht anhand der ID löschen.

bash
mutation DeleteChatItem($id: ID!) {
  deleteChatItem(id: $id)
}
mutation

deleteChatItems

Massenhaft Chat-Nachrichten löschen, die auf eine Abfrage passen (z. B. "id:msg_x,id:msg_y").

bash
mutation DeleteChatItems($query: String!) {
  deleteChatItems(query: $query)
}
mutation

retryChatItem

Erneutes Senden einer fehlgeschlagenen Nachricht versuchen.

bash
mutation RetryChatItem($id: ID!) {
  retryChatItem(id: $id) { id status }
}
mutation

createChatChannel

Einen neuen verschlüsselten Kanal erstellen, der diesem Gerät gehört.

bash
mutation CreateChatChannel($name: String!) {
  createChatChannel(name: $name) {
    id name owner version status createdAt
  }
}
mutation

updateChatChannel

Einen Chat-Kanal umbenennen.

bash
mutation UpdateChatChannel($id: ID!, $name: String!) {
  updateChatChannel(id: $id, name: $name) { id name version updatedAt }
}
mutation

deleteChatChannel

Einen Kanal und alle seine Nachrichten löschen.

bash
mutation DeleteChatChannel($id: ID!) {
  deleteChatChannel(id: $id)
}
mutation

leaveChatChannel

Einen Kanal verlassen, den man nicht besitzt.

bash
mutation LeaveChatChannel($id: ID!) {
  leaveChatChannel(id: $id)
}
mutation

addChatChannelMember

Einen Peer in einen selbst gehörenden Kanal einladen.

bash
mutation AddMember($id: ID!, $peerId: String!) {
  addChatChannelMember(id: $id, peerId: $peerId) {
    id members { id status }
  }
}
mutation

removeChatChannelMember

Ein Mitglied aus einem selbst gehörenden Kanal entfernen.

bash
mutation RemoveMember($id: ID!, $peerId: String!) {
  removeChatChannelMember(id: $id, peerId: $peerId) {
    id members { id status }
  }
}
mutation

acceptChatChannelInvite

Eine Einladung annehmen, einem Kanal beizutreten, zu dem man eingeladen wurde.

bash
mutation AcceptChatChannelInvite($id: ID!) {
  acceptChatChannelInvite(id: $id)
}
mutation

declineChatChannelInvite

Eine ausstehende Kanal-Einladung ablehnen.

bash
mutation DeclineChatChannelInvite($id: ID!) {
  declineChatChannelInvite(id: $id)
}