API-Referenz

Chatkanäle

Chatkanäle und Mitglieder verwalten.

Typdefinitionen

graphql
type Mutation {
  acceptChatChannelInvite(id: ID!): Boolean!
  addChatChannelMember(id: ID!, peerId: ID!): ChatChannel!
  createChatChannel(name: String!): ChatChannel!
  declineChatChannelInvite(id: ID!): Boolean!
  deleteChatChannel(id: ID!): Boolean!
  leaveChatChannel(id: ID!): Boolean!
  removeChatChannelMember(id: ID!, peerId: ID!): ChatChannel!
  updateChatChannel(id: ID!, name: String!): ChatChannel!
}

type Query {
  chatChannels: [ChatChannel!]!
}

type Subscription {
  channelsChanged: ChannelChange!
}

type ChannelChange {
	changed: Boolean!
	invite: ChannelInvite
	cancel: ChannelInviteCancellation
}

type ChannelInvite {
	channelId: ID!
	channelName: String!
	ownerPeerId: ID!
	ownerPeerName: String!
}

type ChannelInviteCancellation {
	channelId: ID!
	ownerPeerId: ID!
}

enum ChannelMemberStatus {
	JOINED
	PENDING
}

type ChatChannel {
	actions: ChatChannelActions!
	id: ID!
	ownerId: ID!
	name: String!
	members: [ChatChannelMember!]!
	
	version: Long!
	status: ChatChannelStatus!
	createdAt: Instant!
	updatedAt: Instant!
	key: String!
}

type ChatChannelActions {
	isOwner: Boolean!
	canRename: Boolean!
	canManageMembers: Boolean!
	canLeave: Boolean!
	canDelete: Boolean!
}

type ChatChannelMember {
	peerId: ID!
	status: ChannelMemberStatus!
}

enum ChatChannelStatus {
	JOINED
	LEFT
	KICKED
}

scalar Instant

scalar Long

Operationen

mutation

acceptChatChannelInvite

Nimmt eine Einladung zum Beitritt zu einem Kanal an.

graphql
mutation acceptChatChannelInvite($id: ID!) {
  acceptChatChannelInvite(id: $id)
}
mutation

addChatChannelMember

Lädt ein Gerät in einen eigenen Kanal ein.

graphql
mutation addChatChannelMember($id: ID!, $peerId: ID!) {
  addChatChannelMember(id: $id, peerId: $peerId) { id ownerId name version status createdAt updatedAt key }
}
mutation

createChatChannel

Erstellt einen neuen verschlüsselten Kanal im Eigentum dieses Geräts.

graphql
mutation createChatChannel($name: String!) {
  createChatChannel(name: $name) { id ownerId name version status createdAt updatedAt key }
}
mutation

declineChatChannelInvite

Lehnt eine ausstehende Kanaleinladung ab.

graphql
mutation declineChatChannelInvite($id: ID!) {
  declineChatChannelInvite(id: $id)
}
mutation

deleteChatChannel

Löscht einen Kanal und alle zugehörigen Nachrichten.

graphql
mutation deleteChatChannel($id: ID!) {
  deleteChatChannel(id: $id)
}
mutation

leaveChatChannel

Verlässt einen Kanal, dessen Eigentümer der Aufrufer nicht ist.

graphql
mutation leaveChatChannel($id: ID!) {
  leaveChatChannel(id: $id)
}
mutation

removeChatChannelMember

Entfernt ein Mitglied aus einem eigenen Kanal.

graphql
mutation removeChatChannelMember($id: ID!, $peerId: ID!) {
  removeChatChannelMember(id: $id, peerId: $peerId) { id ownerId name version status createdAt updatedAt key }
}
mutation

updateChatChannel

Benennt einen Chatkanal um.

graphql
mutation updateChatChannel($id: ID!, $name: String!) {
  updateChatChannel(id: $id, name: $name) { id ownerId name version status createdAt updatedAt key }
}
query

chatChannels

Listet alle Kanäle auf, die dem Gerät gehören oder denen es beigetreten ist.

graphql
query chatChannels {
  chatChannels { id ownerId name version status createdAt updatedAt key }
}
subscription

channelsChanged

Empfängt Informationen über Chatkanaländerungen.

graphql
subscription channelsChanged {
  channelsChanged { changed }
}