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 }
}