Riferimento API

Canali di chat

Gestisci i canali di chat e i loro membri.

Definizioni di tipo

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

Operazioni

mutation

acceptChatChannelInvite

Accettare un invito a entrare in un canale per cui si è ricevuto l’invito.

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

addChatChannelMember

Invitare un peer in un canale di cui si è proprietari.

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

createChatChannel

Creare un nuovo canale cifrato di proprietà di questo dispositivo.

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

declineChatChannelInvite

Rifiutare un invito in sospeso a un canale.

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

deleteChatChannel

Eliminare un canale e tutti i suoi messaggi.

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

leaveChatChannel

Uscire da un canale di cui non si è proprietari.

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

removeChatChannelMember

Rimuovere un membro da un canale di cui si è proprietari.

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

updateChatChannel

Rinominare un canale di chat.

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

chatChannels

Elencare tutti i canali di chat di cui il dispositivo è proprietario o membro.

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

channelsChanged

Ricevere informazioni sulle modifiche ai canali di chat.

graphql
subscription channelsChanged {
  channelsChanged { changed }
}