Harmony Chat
Home Docs Github Try Now

Reference: protocol.chat.v1

Table Of Contents

Message Types

GetUserRequest

Fields

Name Type
user_id uint64

GetUserResponse

Fields

Name Type
user_name string
user_avatar string
UNHANDLED TYPE
is_bot bool

GetUserBulkRequest

Fields

Name Type
user_ids uint64

GetUserBulkResponse

Fields

Name Type
users protocol.chat.v1.GetUserResponse

GetUserMetadataRequest

Fields

Name Type
app_id string

GetUserMetadataResponse

Fields

Name Type
metadata string

ProfileUpdateRequest

Fields

Name Type
new_username string
update_username bool
new_avatar string
update_avatar bool
UNHANDLED TYPE
update_status bool
is_bot bool
update_is_bot bool

CreateGuildRequest

Fields

Name Type
metadata protocol.harmonytypes.v1.Metadata
guild_name string
picture_url string

CreateGuildResponse

Fields

Name Type
guild_id uint64

CreateInviteRequest

Fields

Name Type
guild_id uint64
name string
possible_uses int32

CreateInviteResponse

Fields

Name Type
name string

GetGuildListRequest

Fields

Name Type

GetGuildListResponse

Fields

Name Type
guilds protocol.chat.v1.GetGuildListResponse.GuildListEntry

GetGuildRequest

Fields

Name Type
guild_id uint64

GetGuildResponse

Fields

Name Type
metadata protocol.harmonytypes.v1.Metadata
guild_name string
guild_owner uint64
guild_picture string

GetGuildInvitesRequest

Fields

Name Type
guild_id uint64

GetGuildInvitesResponse

Fields

Name Type
invites protocol.chat.v1.GetGuildInvitesResponse.Invite

GetGuildMembersRequest

Fields

Name Type
guild_id uint64

GetGuildMembersResponse

Fields

Name Type
members uint64

UpdateGuildInformationRequest

Fields

Name Type
guild_id uint64
new_guild_name string
update_guild_name bool
new_guild_picture string
update_guild_picture bool
metadata protocol.harmonytypes.v1.Metadata
update_metadata bool

DeleteGuildRequest

Fields

Name Type
guild_id uint64

DeleteInviteRequest

Fields

Name Type
guild_id uint64
invite_id string

JoinGuildRequest

Fields

Name Type
invite_id string

JoinGuildResponse

Fields

Name Type
guild_id uint64

PreviewGuildRequest

Fields

Name Type
invite_id string

PreviewGuildResponse

Fields

Name Type
name string
avatar string
member_count uint64

LeaveGuildRequest

Fields

Name Type
guild_id uint64

BanUserRequest

Fields

Name Type
guild_id uint64
user_id uint64

KickUserRequest

Fields

Name Type
guild_id uint64
user_id uint64

UnbanUserRequest

Fields

Name Type
guild_id uint64
user_id uint64

GetGuildListResponse.GuildListEntry

Fields

Name Type
guild_id uint64
host string

GetGuildInvitesResponse.Invite

Fields

Name Type
invite_id string
possible_uses int32
use_count int32

CreateChannelRequest

Fields

Name Type
guild_id uint64
channel_name string
is_category bool
previous_id uint64
next_id uint64
metadata protocol.harmonytypes.v1.Metadata

CreateChannelResponse

Fields

Name Type
channel_id uint64

GetGuildChannelsRequest

Fields

Name Type
guild_id uint64

GetGuildChannelsResponse

Fields

Name Type
channels protocol.chat.v1.GetGuildChannelsResponse.Channel

UpdateChannelInformationRequest

Fields

Name Type
guild_id uint64
channel_id uint64
name string
update_name bool
metadata protocol.harmonytypes.v1.Metadata
update_metadata bool

UpdateChannelOrderRequest

Fields

Name Type
guild_id uint64
channel_id uint64
previous_id uint64
next_id uint64

DeleteChannelRequest

Fields

Name Type
guild_id uint64
channel_id uint64

TypingRequest

Fields

Name Type
guild_id uint64
channel_id uint64

GetGuildChannelsResponse.Channel

Fields

Name Type
metadata protocol.harmonytypes.v1.Metadata
channel_id uint64
channel_name string
is_category bool

GetChannelMessagesRequest

Fields

Name Type
guild_id uint64
channel_id uint64
before_message uint64

GetChannelMessagesResponse

Fields

Name Type
reached_top bool
messages protocol.harmonytypes.v1.Message

GetMessageRequest

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64

GetMessageResponse

Fields

Name Type
message protocol.harmonytypes.v1.Message

DeleteMessageRequest

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64

TriggerActionRequest

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64
action_id string
action_data string

SendMessageRequest

Fields

Name Type
guild_id uint64
channel_id uint64
content protocol.harmonytypes.v1.Content
echo_id uint64
metadata protocol.harmonytypes.v1.Metadata
overrides protocol.harmonytypes.v1.Override
in_reply_to uint64

SendMessageResponse

Fields

Name Type
message_id uint64

UpdateMessageTextRequest

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64
new_content string

CreateEmotePackRequest

Fields

Name Type
pack_name string

CreateEmotePackResponse

Fields

Name Type
pack_id uint64

GetEmotePacksRequest

Fields

Name Type

GetEmotePacksResponse

Fields

Name Type
packs protocol.chat.v1.GetEmotePacksResponse.EmotePack

GetEmotePackEmotesRequest

Fields

Name Type
pack_id uint64

GetEmotePackEmotesResponse

Fields

Name Type
emotes protocol.chat.v1.GetEmotePackEmotesResponse.Emote

AddEmoteToPackRequest

Fields

Name Type
pack_id uint64
image_id string
name string

DeleteEmoteFromPackRequest

Fields

Name Type
pack_id uint64
image_id string

DeleteEmotePackRequest

Fields

Name Type
pack_id uint64

DequipEmotePackRequest

Fields

Name Type
pack_id uint64

GetEmotePacksResponse.EmotePack

Fields

Name Type
pack_id uint64
pack_owner uint64
pack_name string

GetEmotePackEmotesResponse.Emote

Fields

Name Type
image_id string
name string

QueryPermissionsRequest

Fields

Name Type
guild_id uint64
channel_id uint64
check_for string
as uint64

QueryPermissionsResponse

Fields

Name Type
ok bool

Permission

Fields

Name Type
matches string
UNHANDLED TYPE

PermissionList

Fields

Name Type
permissions protocol.chat.v1.Permission

SetPermissionsRequest

Fields

Name Type
guild_id uint64
channel_id uint64
role_id uint64
perms protocol.chat.v1.PermissionList

GetPermissionsRequest

Fields

Name Type
guild_id uint64
channel_id uint64
role_id uint64

GetPermissionsResponse

Fields

Name Type
perms protocol.chat.v1.PermissionList

Role

Fields

Name Type
role_id uint64
name string
color int32
hoist bool
pingable bool

MoveRoleRequest

Fields

Name Type
guild_id uint64
role_id uint64
before_id uint64
after_id uint64

MoveRoleResponse

Fields

Name Type

GetGuildRolesRequest

Fields

Name Type
guild_id uint64

GetGuildRolesResponse

Fields

Name Type
roles protocol.chat.v1.Role

AddGuildRoleRequest

Fields

Name Type
guild_id uint64
role protocol.chat.v1.Role

AddGuildRoleResponse

Fields

Name Type
role_id uint64

DeleteGuildRoleRequest

Fields

Name Type
guild_id uint64
role_id uint64

ModifyGuildRoleRequest

Fields

Name Type
guild_id uint64
role protocol.chat.v1.Role
modify_name bool
modify_color bool
modify_hoist bool
modify_pingable bool

ManageUserRolesRequest

Fields

Name Type
guild_id uint64
user_id uint64
give_role_ids uint64
take_role_ids uint64

GetUserRolesRequest

Fields

Name Type
guild_id uint64
user_id uint64

GetUserRolesResponse

Fields

Name Type
roles uint64

StreamEventsRequest

Fields

Name Type
subscribe_to_guild protocol.chat.v1.StreamEventsRequest.SubscribeToGuild
subscribe_to_actions protocol.chat.v1.StreamEventsRequest.SubscribeToActions
subscribe_to_homeserver_events protocol.chat.v1.StreamEventsRequest.SubscribeToHomeserverEvents

Event

Fields

Name Type
guild_added_to_list protocol.chat.v1.Event.GuildAddedToList
guild_removed_from_list protocol.chat.v1.Event.GuildRemovedFromList
action_performed protocol.chat.v1.Event.ActionPerformed
sent_message protocol.chat.v1.Event.MessageSent
edited_message protocol.chat.v1.Event.MessageUpdated
deleted_message protocol.chat.v1.Event.MessageDeleted
created_channel protocol.chat.v1.Event.ChannelCreated
edited_channel protocol.chat.v1.Event.ChannelUpdated
deleted_channel protocol.chat.v1.Event.ChannelDeleted
edited_guild protocol.chat.v1.Event.GuildUpdated
deleted_guild protocol.chat.v1.Event.GuildDeleted
joined_member protocol.chat.v1.Event.MemberJoined
left_member protocol.chat.v1.Event.MemberLeft
role_moved protocol.chat.v1.Event.RoleMoved
profile_updated protocol.chat.v1.Event.ProfileUpdated
typing protocol.chat.v1.Event.Typing

StreamEventsRequest.SubscribeToGuild

Fields

Name Type
guild_id uint64

StreamEventsRequest.SubscribeToActions

Fields

Name Type

StreamEventsRequest.SubscribeToHomeserverEvents

Fields

Name Type

Event.MessageSent

Fields

Name Type
echo_id uint64
message protocol.harmonytypes.v1.Message

Event.MessageUpdated

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64
edited_at google.protobuf.Timestamp
content string

Event.MessageDeleted

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64

Event.ChannelCreated

Fields

Name Type
guild_id uint64
channel_id uint64
name string
previous_id uint64
next_id uint64
is_category bool
metadata protocol.harmonytypes.v1.Metadata

Event.ChannelUpdated

Fields

Name Type
guild_id uint64
channel_id uint64
name string
update_name bool
previous_id uint64
next_id uint64
update_order bool
metadata protocol.harmonytypes.v1.Metadata
update_metadata bool

Event.ChannelDeleted

Fields

Name Type
guild_id uint64
channel_id uint64

Event.GuildUpdated

Fields

Name Type
guild_id uint64
name string
update_name bool
picture string
update_picture bool
metadata protocol.harmonytypes.v1.Metadata
update_metadata bool

Event.GuildDeleted

Fields

Name Type
guild_id uint64

Event.MemberJoined

Fields

Name Type
member_id uint64
guild_id uint64

Event.MemberLeft

Fields

Name Type
member_id uint64
guild_id uint64
UNHANDLED TYPE

Event.GuildAddedToList

Fields

Name Type
guild_id uint64
homeserver string

Event.GuildRemovedFromList

Fields

Name Type
guild_id uint64
homeserver string

Event.ActionPerformed

Fields

Name Type
guild_id uint64
channel_id uint64
message_id uint64
action_id string
action_data string

Event.RoleMoved

Fields

Name Type
guild_id uint64
role_id uint64

Event.ProfileUpdated

Fields

Name Type
user_id uint64
new_username string
update_username bool
new_avatar string
update_avatar bool
UNHANDLED TYPE
update_status bool
is_bot bool
update_is_bot bool

Event.Typing

Fields

Name Type
user_id uint64
guild_id uint64
channel_id uint64

Services

ChatService

Unary Methods

Name Request Response
CreateGuild protocol.chat.v1.CreateGuildRequest protocol.chat.v1.CreateGuildResponse
CreateInvite protocol.chat.v1.CreateInviteRequest protocol.chat.v1.CreateInviteResponse
CreateChannel protocol.chat.v1.CreateChannelRequest protocol.chat.v1.CreateChannelResponse
CreateEmotePack protocol.chat.v1.CreateEmotePackRequest protocol.chat.v1.CreateEmotePackResponse
GetGuildList protocol.chat.v1.GetGuildListRequest protocol.chat.v1.GetGuildListResponse
GetGuild protocol.chat.v1.GetGuildRequest protocol.chat.v1.GetGuildResponse
GetGuildInvites protocol.chat.v1.GetGuildInvitesRequest protocol.chat.v1.GetGuildInvitesResponse
GetGuildMembers protocol.chat.v1.GetGuildMembersRequest protocol.chat.v1.GetGuildMembersResponse
GetGuildChannels protocol.chat.v1.GetGuildChannelsRequest protocol.chat.v1.GetGuildChannelsResponse
GetChannelMessages protocol.chat.v1.GetChannelMessagesRequest protocol.chat.v1.GetChannelMessagesResponse
GetMessage protocol.chat.v1.GetMessageRequest protocol.chat.v1.GetMessageResponse
GetEmotePacks protocol.chat.v1.GetEmotePacksRequest protocol.chat.v1.GetEmotePacksResponse
GetEmotePackEmotes protocol.chat.v1.GetEmotePackEmotesRequest protocol.chat.v1.GetEmotePackEmotesResponse
UpdateGuildInformation protocol.chat.v1.UpdateGuildInformationRequest google.protobuf.Empty
UpdateChannelInformation protocol.chat.v1.UpdateChannelInformationRequest google.protobuf.Empty
UpdateChannelOrder protocol.chat.v1.UpdateChannelOrderRequest google.protobuf.Empty
UpdateMessageText protocol.chat.v1.UpdateMessageTextRequest google.protobuf.Empty
AddEmoteToPack protocol.chat.v1.AddEmoteToPackRequest google.protobuf.Empty
DeleteGuild protocol.chat.v1.DeleteGuildRequest google.protobuf.Empty
DeleteInvite protocol.chat.v1.DeleteInviteRequest google.protobuf.Empty
DeleteChannel protocol.chat.v1.DeleteChannelRequest google.protobuf.Empty
DeleteMessage protocol.chat.v1.DeleteMessageRequest google.protobuf.Empty
DeleteEmoteFromPack protocol.chat.v1.DeleteEmoteFromPackRequest google.protobuf.Empty
DeleteEmotePack protocol.chat.v1.DeleteEmotePackRequest google.protobuf.Empty
DequipEmotePack protocol.chat.v1.DequipEmotePackRequest google.protobuf.Empty
JoinGuild protocol.chat.v1.JoinGuildRequest protocol.chat.v1.JoinGuildResponse
LeaveGuild protocol.chat.v1.LeaveGuildRequest google.protobuf.Empty
TriggerAction protocol.chat.v1.TriggerActionRequest google.protobuf.Empty
SendMessage protocol.chat.v1.SendMessageRequest protocol.chat.v1.SendMessageResponse
QueryHasPermission protocol.chat.v1.QueryPermissionsRequest protocol.chat.v1.QueryPermissionsResponse
SetPermissions protocol.chat.v1.SetPermissionsRequest google.protobuf.Empty
GetPermissions protocol.chat.v1.GetPermissionsRequest protocol.chat.v1.GetPermissionsResponse
MoveRole protocol.chat.v1.MoveRoleRequest protocol.chat.v1.MoveRoleResponse
GetGuildRoles protocol.chat.v1.GetGuildRolesRequest protocol.chat.v1.GetGuildRolesResponse
AddGuildRole protocol.chat.v1.AddGuildRoleRequest protocol.chat.v1.AddGuildRoleResponse
ModifyGuildRole protocol.chat.v1.ModifyGuildRoleRequest google.protobuf.Empty
DeleteGuildRole protocol.chat.v1.DeleteGuildRoleRequest google.protobuf.Empty
ManageUserRoles protocol.chat.v1.ManageUserRolesRequest google.protobuf.Empty
GetUserRoles protocol.chat.v1.GetUserRolesRequest protocol.chat.v1.GetUserRolesResponse
GetUser protocol.chat.v1.GetUserRequest protocol.chat.v1.GetUserResponse
GetUserBulk protocol.chat.v1.GetUserBulkRequest protocol.chat.v1.GetUserBulkResponse
GetUserMetadata protocol.chat.v1.GetUserMetadataRequest protocol.chat.v1.GetUserMetadataResponse
ProfileUpdate protocol.chat.v1.ProfileUpdateRequest google.protobuf.Empty
Typing protocol.chat.v1.TypingRequest google.protobuf.Empty
PreviewGuild protocol.chat.v1.PreviewGuildRequest protocol.chat.v1.PreviewGuildResponse
BanUser protocol.chat.v1.BanUserRequest google.protobuf.Empty
KickUser protocol.chat.v1.KickUserRequest google.protobuf.Empty
UnbanUser protocol.chat.v1.UnbanUserRequest google.protobuf.Empty

Streaming Methods

Name Client Streams Server Streams
StreamEvents protocol.chat.v1.StreamEventsRequest protocol.chat.v1.Event