Reference: protocol.emote.v1

Services

EmoteService

Harmony’s Emote service manages the emotes and emote packs. Fields

CreateEmotePack

protocol.emote.v1.CreateEmotePackRequest -> protocol.emote.v1.CreateEmotePackResponse

Endpoint to create an emote pack.


CreateEmotePackRequest

Used in the CreateEmotePack endpoint.

Fields

pack_name

Type: optional string

the name of the pack.


CreateEmotePackResponse

Used in the CreateEmotePack endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.


GetEmotePacks

protocol.emote.v1.GetEmotePacksRequest -> protocol.emote.v1.GetEmotePacksResponse

Endpoint to get the emote packs you have equipped.


GetEmotePacksRequest

Used in the GetEmotePacks endpoint.

This item has no fields.


GetEmotePacksResponse

Used in the GetEmotePacks endpoint.

Fields

packs

Type: repeated protocol.emote.v1.EmotePack

The list of emote packs.


GetEmotePackEmotes

protocol.emote.v1.GetEmotePackEmotesRequest -> protocol.emote.v1.GetEmotePackEmotesResponse

Endpoint to get the emotes in an emote pack.


GetEmotePackEmotesRequest

Used in the GetEmotes endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.


GetEmotePackEmotesResponse

Used in the GetEmotes endpoint.

Fields

emotes

Type: repeated protocol.emote.v1.Emote

The list of emotes in the pack.


AddEmoteToPack

protocol.emote.v1.AddEmoteToPackRequest -> protocol.emote.v1.AddEmoteToPackResponse

Endpoint to add an emote to an emote pack that you own.


AddEmoteToPackRequest

Used in the AddEmoteToPack endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.

emote

Type: optional protocol.emote.v1.Emote

The emote to add.


AddEmoteToPackResponse

Used in the AddEmoteToPack endpoint.

This item has no fields.


DeleteEmotePack

protocol.emote.v1.DeleteEmotePackRequest -> protocol.emote.v1.DeleteEmotePackResponse

Endpoint to delete an emote pack that you own.


DeleteEmotePackRequest

Used in the DeleteEmotePack endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.


DeleteEmotePackResponse

Used in the DeleteEmotePack endpoint.

This item has no fields.


DeleteEmoteFromPack

protocol.emote.v1.DeleteEmoteFromPackRequest -> protocol.emote.v1.DeleteEmoteFromPackResponse

Endpoint to delete an emote from an emote pack.


DeleteEmoteFromPackRequest

Used in the DeleteEmoteFromPack endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.

name

Type: optional string

The name of the emote to delete.


DeleteEmoteFromPackResponse

Used in the DeleteEmoteFromPack endpoint.

This item has no fields.


DequipEmotePack

protocol.emote.v1.DequipEmotePackRequest -> protocol.emote.v1.DequipEmotePackResponse

Endpoint to dequip an emote pack that you have equipped.


DequipEmotePackRequest

Used in the DequipEmotePack endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.


DequipEmotePackResponse

Used in the DequipEmotePack endpoint.

This item has no fields.


EquipEmotePack

protocol.emote.v1.EquipEmotePackRequest -> protocol.emote.v1.EquipEmotePackResponse

Endpoint to equip an emote pack.


EquipEmotePackRequest

Used in the EquipEmotePack endpoint.

Fields

pack_id

Type: optional uint64

The ID of the pack.


EquipEmotePackResponse

Used in the EquipEmotePack endpoint.

This item has no fields.

Standalone Message Types

EmotePack

Data for a single pack of emotes.

Fields

pack_id

Type: optional uint64

The ID of the pack.

pack_owner

Type: optional uint64

The ID of the user who created the pack.

pack_name

Type: optional string

The name of the pack.


Emote

Data for a single emote.

Fields

image_id

Type: optional string

The image ID of the emote. This is the ID of the image in the image store (same place attachments are stored).

name

Type: optional string

The name of the emote.


EmotePackUpdated

Event sent when an emote pack’s information is changed.

Should only be sent to users who have the pack equipped.

Fields

pack_id

Type: optional uint64

ID of the pack that was updated.

new_pack_name

Type: optional string

New pack name of the pack.


EmotePackDeleted

Event sent when an emote pack is deleted.

Should only be sent to users who have the pack equipped. Should also be sent if a user dequips an emote pack, only to the user that dequipped it.

Fields

pack_id

Type: optional uint64

ID of the pack that was deleted.


EmotePackAdded

Event sent when an emote pack is added.

Should only be sent to the user who equipped the pack.

Fields

pack

Type: optional protocol.emote.v1.EmotePack

Emote pack that was equipped by the user.


EmotePackEmotesUpdated

Event sent when an emote pack’s emotes were changed.

Should only be sent to users who have the pack equipped.

Fields

pack_id

Type: optional uint64

ID of the pack to update the emotes of.

added_emotes

Type: repeated protocol.emote.v1.Emote

The added emotes.

deleted_emotes

Type: repeated string

The names of the deleted emotes.


StreamEvent

Describes an emote service event.

Fields

emote_pack_added

Type: optional protocol.emote.v1.EmotePackAdded

Send the emote pack added event.

emote_pack_updated

Type: optional protocol.emote.v1.EmotePackUpdated

Send the emote pack updated event.

emote_pack_deleted

Type: optional protocol.emote.v1.EmotePackDeleted

Send the emote pack deleted event.

emote_pack_emotes_updated

Type: optional protocol.emote.v1.EmotePackEmotesUpdated

Send the emote pack emotes updated event.