PlainApp
Referência da API

Canais de conversa

Gerencie canais de conversa e seus membros.

Definições de 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

Operações

mutation

acceptChatChannelInvite

Aceitar um convite para aderir a um canal para o qual foi convidado.

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

addChatChannelMember

Convidar um par para um canal de que é proprietário.

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

createChatChannel

Criar um novo canal cifrado de que este dispositivo é proprietário.

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

declineChatChannelInvite

Recusar um convite pendente para um canal.

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

deleteChatChannel

Eliminar um canal e todas as suas mensagens.

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

leaveChatChannel

Sair de um canal de que não é proprietário.

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

removeChatChannelMember

Remover um membro de um canal de que é proprietário.

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

updateChatChannel

Mudar o nome de um canal de conversa.

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

chatChannels

Listar todos os canais de conversa de que o dispositivo é proprietário ou membro.

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

channelsChanged

Receber informações de alterações dos canais de conversa.

graphql
subscription channelsChanged {
  channelsChanged { changed }
}