PlainApp
API குறிப்பு

அரட்டைச் சேனல்கள்

அரட்டைச் சேனல்களையும் உறுப்பினர்களையும் நிர்வகிக்கவும்.

வகை வரையறைகள்

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

செயல்பாடுகள்

mutation

acceptChatChannelInvite

நீங்கள் அழைக்கப்பட்ட சேனலில் சேருவதற்கான அழைப்பை ஏற்கவும்.

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

addChatChannelMember

உங்களுக்குச் சொந்தமான சேனலுக்கு ஒரு பியரை அழைக்கவும்.

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

createChatChannel

இந்தச் சாதனத்தை உரிமையாளராகக் கொண்ட புதிய மறைகுறியாக்கப்பட்ட சேனலை உருவாக்கவும்.

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

declineChatChannelInvite

நிலுவையிலுள்ள சேனல் அழைப்பை மறுக்கவும்.

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

deleteChatChannel

சேனலையும் அதன் அனைத்துச் செய்திகளையும் நீக்கவும்.

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

leaveChatChannel

உங்களுக்குச் சொந்தமில்லாத சேனலை விட்டு வெளியேறவும்.

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

removeChatChannelMember

உங்களுக்குச் சொந்தமான சேனலிலிருந்து உறுப்பினரை அகற்றவும்.

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

updateChatChannel

அரட்டை சேனலின் பெயரை மாற்றவும்.

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

chatChannels

சாதனம் சொந்தமாகக் கொண்டுள்ள அல்லது சேர்ந்துள்ள அனைத்து அரட்டை சேனல்களையும் பட்டியலிடவும்.

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

channelsChanged

அரட்டை சேனல் மாற்றத் தகவலைப் பெறவும்.

graphql
subscription channelsChanged {
  channelsChanged { changed }
}