package common.entity.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Pseudo-entity that indicates the given alias JID is blocked by the requesting user

Used in: RosterEntry

• optional v1.XiAliasJid alias_jid = 1

Used in: EntityUser, profile.v1.AnonMatchAvatarAction

• optional XiUuid avatar_id = 1

Background Pic Extension

Used in: EntityBot, EntityGroup, EntityUser, profile.v1.BackgroundProfilePicExtensionAction, mobile.entity.v1.PublicGroupMemberProfile

• optional ProfilePicExtensionDetail extension_detail = 1

  The details of this profile pic extension

Used in: EntityBot, EntityGroup, EntityUser, profile.v1.BioAction, mobile.entity.v1.PublicGroupMemberProfile

• string bio = 1

  a biography or short biographical profile of someone or some group

The BotExtensionElement may not be present if this user is not a bot If a user is a bot then BotExtensionElement will be present and is_bot will be true Eventually this element will contain fields such as isTrusted and other attributes

Used in: EntityUserRosterEntry

• bool is_bot = 2

• bool is_trusted = 3

Used in: EntityBot

• string byline = 1

  a short description of a bot, user or a group

Used in: EntityConvo, messagepath.v1.ChatThemeAttachment, profile.v1.ChatThemeAction

• optional XiUuid product_id = 1

  The id of the chat theme product to be displayed - the chat theme assets are fetched from the product data service

Used in: EntityConvo, messagepath.v1.ChatThemeAttachment

• ChatThemeLockElement.LockStatus lock_status = 1

  The current permission settings for modifying a conversation's chat theme

Used in: ChatThemeLockElement

• UNLOCKED = 0

• ADMIN_LOCKED = 1

• bool deactivated = 1

Used in: EntityUserRosterEntry, mobile.entity.v1.AnonChatMemberProfile, mobile.entity.v1.PublicGroupMemberProfile

• string display_name = 1

Used in: EntityUserRosterEntry, profile.v1.EmojiStatusAction, mobile.entity.v1.PublicGroupMemberProfile

• optional InnerKikAssetElement emoji_status = 1

Used in: mobile.entity.v1.GetBotsResponse

• optional XiBareUserJid id = 1

• optional BioElement bio_element = 100

  Use tag number range of [100-199] for elements sourced from profile service

• optional OriginalProfilePicExtensionElement original_profile_pic_extension = 101

  Original Profile Pic Extension

• optional BackgroundProfilePicExtensionElement background_profile_pic_extension = 102

  Background Pic Extension

• optional RegistrationElement registration_element = 103

  Registration Element for bot

• optional BylineElement byline_element = 200

  Byline for a bot

• optional RatingSummary rating_summary = 201

  Rating information for the bot

• optional TrustedElement trusted = 202

  Is the bot trusted

Used in: mobile.entity.v1.GetConvosResponse

• optional v1.XiConvoId id = 1

• optional ChatThemeElement chat_theme_element = 100

• optional ChatThemeLockElement chat_theme_lock_element = 101

Used in: mobile.entity.v1.GetGroupsResponse

• optional XiGroupJid id = 1

• optional BioElement bio_element = 100

  Use tag number range of [100-199] for elements sourced from profile service

• optional OriginalProfilePicExtensionElement original_profile_pic_extension = 101

  Original Profile Pic Extension

• optional BackgroundProfilePicExtensionElement background_profile_pic_extension = 102

  Background Pic Extension

• optional MaxGroupSizeElement max_group_size_element = 103

  Maximum Group Size

• optional KinEnabledElement kin_enabled_element = 104

  Is KIN enabled

Entity containing information of group that is broadcast to its members' rosters.

Used in: RosterEntry, mobile.entity.v1.GetGroupRosterEntriesResponse

• optional XiGroupJid id = 1

• optional PublicElement public = 2

• optional GroupCodeElement group_code = 3

  Hashtag for the group

• optional GroupNameElement group_name = 4

• optional ProfilePicElement profile_pic = 5

• optional GroupMemberListElement members = 6

• optional google.protobuf.Timestamp last_updated_ts = 7

************************************************** Key used by Entity Warehouse, Subscription Service, etc to explicitly identify entities ************************************************** NOTE: EntityKey has specific IDs that are expected to go with specific EntityTypes. Please check the comments for EntityType to understand what id values are valid (Ideally we would restructure the EntityKey message, but it's already too embedded to change now)

• EntityKey.EntityType type = 1

• oneof id

  • XiBareUserJid user_jid = 2

    user_jid requires type to be USER or USER_ROSTER_ENTRY

  • XiGroupJid group_jid = 3

    group_jid requires type to be GROUP or GROUP_ROSTER_ENTRY

  • v1.XiConvoId convo_id = 4

    convo_id requires type to be CONVO

  • v1.XiAliasJid alias_jid = 5

    alias_jid requires type to be ALIAS_BLOCK_ENTRY

Used in: EntityKey

• USER = 0

  USER - expects id to contain 'user_jid'

• GROUP = 1

  GROUP - expects id to contain 'group_jid'

• USER_ROSTER_ENTRY = 2

  USER_ROSTER_ENTRY - expects id to contain 'user_jid'

• GROUP_ROSTER_ENTRY = 3

  GROUP_ROSTER_ENTRY - expects id to contain 'group_jid'

• CONVO = 4

  CONVO - expects id to contain 'convo_id'

• ALIAS_BLOCK_ENTRY = 5

  Note: ALIAS_BLOCK_ENTRY is not an entity type actually stored within EntityWarehouse. Used to identify a pseudo-entity for use within Internal Subscription Service. ALIAS_BLOCK_ENTRY - expects id to contain 'alias_jid'

Used in: mobile.entity.v1.GetUsersResponse

• optional XiBareUserJid id = 1

• optional BioElement bio_element = 100

  Use tag number range of [100-199] for elements sourced from profile service

• optional OriginalProfilePicExtensionElement original_profile_pic_extension = 101

  Original Profile Pic Extension

• optional BackgroundProfilePicExtensionElement background_profile_pic_extension = 102

  Background Pic Extension

• optional RegistrationElement registration_element = 103

  Registration Element for user

• optional InterestsElement interests_element = 104

  User Interests Element

• optional AnonMatchAvatarElement anon_match_avatar_element = 105

  Anon Match Avatar Element

• optional KinUserIdElement kin_user_id_element = 107

  Kin User ID Element

Entity containing information of a single user that is broadcasted to his/her rosters.

Used in: RosterEntry, mobile.entity.v1.GetUserRosterEntriesResponse

• optional XiBareUserJid id = 1

• optional EmojiStatusElement emoji_status_element = 2

• optional UsernameElement username = 3

• optional DisplayNameElement display_name = 4

• optional ProfilePicElement profile_pic = 5

• optional BotExtensionElement bot_extension = 6

  The presence of this element indicates that this User is a bot, regardless of the element's content; Regular Users will never have this element.

• optional UserTypeElement user_type = 7

  User type of the account

Hashtag for a group

Used in: EntityGroupRosterEntry

• string code = 1

Used in: EntityGroupRosterEntry

• repeated GroupMemberRoster group_members = 1

All the roster info for a single group member that's part of a GroupRosterEntry

Note; To people looking at this in the future, DO NOT be tempted to merge user_jid and alias_jid into a oneof. We can't do it.

Used in: GroupMemberListElement

• optional XiBareUserJid user_jid = 1

  We added the alias_jid field too late. There are some issues here, and no solution is perfect. Firstly, the database is already populated with user_jid values and those can NEVER change Why is alias_jid of type XiAliasJid though and not XiBareUserJid? Consider how both of these fields work together. If user_jid is not there, check for alias_jid if alias_jid is not there, check for user_jid The three relevant types are XiBareUserJid, XiAliasJid, and XiBareUserOrAliasJid If we remove or change the type of field 1 then we need to convert a bunch of values in the database but changing this API at the time of writing was too high priority to do that and so field 1 must remain an XiBareUserJid Given that field 1 remains unchanged, we still need to somehow work an XiAliasJid into this message Only two options make any sense. We can make field 3 an XiBareUserOrAliasJid or make it an XiAliasJid We went with an XiAliasJid based on some pretty razor thin advantages and disadvantages, but either way would have created an API that is less than ideal. That's why no oneof and no XiBareUserOrAliasJid

• optional v1.XiAliasJid alias_jid = 3

• GroupMemberRoster.AdminStatus admin_status = 2

• optional GroupMemberRoster.DirectMessagingDisabled direct_messaging_disabled = 4

  Should only be present for public groups that are converted

Used in: GroupMemberRoster

• NONE = 0

• ADMIN = 1

• SUPER_ADMIN = 2

Just a wrapper so we can make it optional

Used in: GroupMemberRoster

• bool direct_messaging_disabled = 1

Used in: EntityGroupRosterEntry

• string name = 1

Contains an kik asset id. A Kik Asset is something that is premade by us and provided to users A kik_asset_id might be something like SMILEY_FACE or FLAG_USA if those assets existed

Used in: EmojiStatusElement, ProfilePicExtensionDetail

• string kik_asset_id = 1

  The id of a Kik Asset

Contains the details of any pic that is accessible by URL

Used in: ProfilePicExtensionDetail

• string full_sized_url = 1

  Full Sized Pic URL

• string thumbnail_url = 2

  Thumbnail Sized Pic URL

• optional google.protobuf.Timestamp last_updated_timestamp = 3

Used in: EntityUser, profile.v1.InterestsAction, mobile.entity.v1.PublicGroupMemberProfile

• repeated InterestsElement.InterestItem interests_element = 1

Used in: InterestsElement

• string id = 1

• string localized_verbiage = 2

Either or not Kin functionality is enabled

Used in: EntityGroup

• bool kin_enabled = 1

Used in: EntityUser, profile.v1.KinUserIdAction, mobile.entity.v1.PublicGroupMemberProfile

• optional v1.XiKinUserId kin_user_id = 1

  Kin User ID maps a Kik user to their Kin wallet address, and is included in all transaction JWT tokens

The maximum number of members allowed in the group concurrently

Used in: EntityGroup

• uint32 max_group_size = 1

  A zero value is more likely to mean there's a widespread problem with groups in general than that this group's maximum member size is really zero. In either case, program defensively and don't allow users to join a group if its size is zero.

Original Profile Pic Extension

Used in: EntityBot, EntityGroup, EntityUser, profile.v1.OriginalProfilePicExtensionAction

• optional ProfilePicExtensionDetail extension_detail = 1

  The details of this profile pic extension

Used in: EntityGroupRosterEntry, EntityUserRosterEntry, mobile.entity.v1.AnonChatMemberProfile, mobile.entity.v1.PublicGroupMemberProfile

• string url = 1

• optional google.protobuf.Timestamp last_updated_timestamp = 2

Used in: BackgroundProfilePicExtensionElement, OriginalProfilePicExtensionElement

• oneof kind

  • InnerPicElement pic = 2

    A picture element. If the user uploads a picture use this

  • InnerKikAssetElement kik_asset = 3

    A Kik Asset element. If the original pic is something we provide, use this

Used in: EntityGroupRosterEntry

• bool is_public = 1

Contains the rating details for an entity.

Used in: EntityBot

• double average_rating = 1

• uint64 total_ratings_count = 2

Used in: EntityBot, EntityUser, mobile.entity.v1.PublicGroupMemberProfile

• optional google.protobuf.Timestamp creation_date = 2

  System time of when the user/group is created or registered

Used in: mobile.entity.v1.SyncMyRosterDataResponse

• oneof roster_entry_kind

  OneOf user or group

  • EntityUserRosterEntry user_data = 1

  • EntityGroupRosterEntry group_data = 2

  • AliasBlockEntry alias_block_data = 4

• bool is_blocked = 3

  Only applies to user rosters Has this person being blocked by roster owner?

Used in: mobile.entity.v1.SyncMyRosterDataRequest, mobile.entity.v1.SyncMyRosterDataResponse

• bytes payload = 1

  Clients MUST NOT interpret this message.

Used in: EntityBot

• bool is_trusted = 1

Used in: EntityUserRosterEntry, mobile.entity.v1.PublicGroupMemberProfile

• accounts.v1.UserType user_type = 1

Used in: EntityUserRosterEntry, mobile.entity.v1.PrivateProfile

• string username = 1