package mobile.entity.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Entity
entity_service.proto:46---------------------------------------------------------------------------- Service Interfaces - GetXXX methods ---------------------------------------------------------------------------- Mobile-facing service allowing pulling of entities by batch of up to 20 ids Visibility is not controlled by EntityService, it is assumed if the caller has id, he/she is visible to all elements of the entity. Typically 4 lists might be returned: 1. The list of entities (excluding soft DELETED) 2. retriable_ids: A set of IDs that could not be retrieved for a transient reason. Clients should retry right away with this set of IDs in order to get the complete list. Result will be set to Result.PARTIAL if this set is non-empty. 3. failed_ids: A set of IDs of those retrieval failed. Clients should _not_ retry with these IDs. Result will be set to Result.PARTIAL if this set is non-empty. 4. not_found_ids: Requested but not found on server or has been deleted. Not found is not considered failed. So if you call GetUsers(id1-3) and all 3 ids are not found, you'd have a response with Result.OK; empty entity list and a not_found_ids of id1-3. Error Handling: 1. Always try/catch rpc errors or anything unexpected 2. Response always return a Result tag, you might want to handle error when Result = PARTIAL 3. If retriable_ids is _not_ empty, further requests should be made until a response with an empty set of retriable_ids is returned. *********************************************************************************
rpc GetUsers (, )
entity_service.proto:48message
entity_service.proto:78repeated ids = 1
message
entity_service.proto:85GetUsersResponse.Result result = 1
repeated users = 10
The set of successfully retrieved EntityUsers. This does _not_ include deleted entities.
repeated retriable_ids = 11
The set of XiBareUserJid's that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of XiBareUserJid's that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of XiBareUserJid's that could not be found (either because the entity doesn't exist, or it was deleted).
rpc GetBots (, )
entity_service.proto:50message
entity_service.proto:114repeated ids = 1
message
entity_service.proto:121GetBotsResponse.Result result = 1
repeated bots = 10
The set of successfully retrieved EntityBot. This does _not_ include deleted entities.
repeated retriable_ids = 11
The set of XiBareUserJid's that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of XiBareUserJid's that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of XiBareUserJid's that could not be found (either because the entity doesn't exist, or it was deleted).
rpc GetGroups (, )
entity_service.proto:52message
entity_service.proto:186repeated ids = 1
message
entity_service.proto:193GetGroupsResponse.Result result = 1
repeated groups = 10
The set of successfully retrieved EntityGroups. This does _not_ include deleted/not found entities
repeated retriable_ids = 11
The set of XiGroupJid's that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of XiGroupJid's that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of XiGroupJid's that could not be found (either because the entity doesn't exist, or it was deleted).
rpc GetConvos (, )
entity_service.proto:54message
entity_service.proto:222repeated ids = 1
message
entity_service.proto:229GetConvosResponse.Result result = 1
repeated convos = 10
The set of successfully retrieved EntityConvo. This does _not_ include deleted/not found entities
repeated retriable_ids = 11
The set of XiConvoId's that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of XiConvoId's that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of XiConvoId's that could not be found (either because the entity doesn't exist, or it was deleted).
message
entity_service.proto:150repeated ids = 1
message
entity_service.proto:157GetUserRosterEntriesResponse.Result result = 1
repeated user_roster_entries = 10
The set of successfully retrieved EntityUserRosterEntries. This does _not_ include deleted entities.
repeated retriable_ids = 11
The set of XiBareUserJids that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of XiBareUserJids that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of XiBareUserJids that could not be found (either because the entity doesn't exist, or it was deleted).
message
entity_service.proto:288repeated ids = 1
message
entity_service.proto:295GetGroupRosterEntriesResponse.Result result = 1
repeated group_roster_entries = 10
The set of successfully retrieved EntityGroupRosterEntries. This does _not_ include deleted entities.
repeated retriable_ids = 11
The set of XiGroupJids that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of XiGroupJids that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of XiGroupJids that could not be found (either because the entity doesn't exist, or it was deleted).
message
entity_service.proto:331repeated ids = 1
message
entity_service.proto:412GetUsersByAliasResponse.Result result = 1
repeated payloads = 10
repeated retriable_ids = 11
The set of RequestedJid that could not be retrieved, but should be retried. It is strongly encouraged (if not necessary) to retry with the set of retriable_ids, until the set is empty. This mechanism provides a tolerance to transient failures, as well as dealing with internal size restrictions (such as max XMPP response size). Retriable ids should be requested again right away; no backoff or delay is required.
repeated failed_ids = 12
The set of RequestedJid that could not be retrieved, but should _not_ be retried.
repeated not_found_ids = 13
The set of RequestedJid that could not be found (either because the entity doesn't exist, or it was deleted).
**************************************************************************************** Get a list of trusted bots. If the list does not fit in one xiphias call, a page token is return for the subsequent page. GetTrustedBots is designed to be temporary and can be obsolete once Harmony 3 - Roster subscription is in place. To eventually obsolete this rpc, entity_service_get_trusted_bots_enabled in https://github.com/kikinteractive/xiphias-api-mobile/blob/master/proto/config/v1/feature_config_service.proto is prepared. The promise is that client will use this boolean to wrap around the GetTrustedBots call, once it is disabled via this config (client calls feature_config_service daily), call to this rpc should reach 0 in 24 hours. Then server can obsolete the rpc from API. ****************************************************************************************
message
entity_service.proto:258optional page_token = 1
If pageToken is absent, server will consider this as getting the first page. See GetTrustedBotsResponse, pageToken is that returned from server from the previous call in case of more.
message
entity_service.proto:267GetTrustedBotsResponse.Result result = 1
Fields are not set when Result != OK
repeated trusted_bots = 2
optional page_token = 3
Only return if there are more come. This is the token for the next page.
NOTE: SyncMyRosterData pulls a page at a time, so time fudging should be applied for the first page call, subsequent pull should use the actual ts in the RosterSyncToken How to tell if it is subsequent pull? Hide has_more in the token for this. NOTE; token should have two ts one for regular subscription and one for mega.
message
subscription_service.proto:38optional token = 1
message
subscription_service.proto:49SyncMyRosterDataResponse.Result result = 1
repeated roster_data = 2
Roster data returned in batches up to 500 or 100KiB (protobuf serialized)
optional token = 3
New token to be used in subsequent call.
bool has_more = 4
Simply indicate the client should continue to pull with token above
message
entity_service.proto:370Information that should be available to everyone for anon chat alias jids
All fields should be optional.
Used in:
optional profile_pic = 2
An optional Profile Pic Element
optional display_name = 7
An optional Display Name Element
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
Used in:
OK = 0
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
message
entity_service.proto:392All fields should be optional. Callers do not necessarily know which fields will be populated in the response.
Used in:
optional public_group_member_profile = 1
An optional PublicGroupMemberProfile, present for group_membership ajid types
optional anon_chat_member_profile = 5
An optional AnonChatMemberProfile, should be present for anon_type ajids
optional private_profile = 2
An optional PrivateProfile
optional id = 3
The RequestedJid that this payload pertains to
int32 request_index = 4
The index in the ids field of the original request that this payload is for
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
Used in:
OK = 0
PARTIAL = 1
PARTIAL indicates that an error occurred when retrieving info for some of the requested ids, but other ids may have been retrieved successfully
message
entity_service.proto:283Used in: ,
bytes token = 1
message
entity_service.proto:382Information that is restricted from public view Requires a two-way relationship between the caller and alias jid
All fields should be optional.
Used in:
optional id = 1
An optional User Jid
optional username = 2
An optional User Name Element
message
entity_service.proto:338Information that should be available to everyone for group_membership alias jids
All fields should be optional.
Used in:
optional bio_element = 1
An optional BioElement
optional profile_pic = 2
An optional Profile Pic Element
optional background_profile_pic_extension = 3
An optional Background Pic Extension
optional registration_element = 4
An optional Registration Element for user
optional interests_element = 5
An optional User Interests Element
optional emoji_status_element = 6
An optional Emoji status element
optional display_name = 7
An optional Display Name Element
optional kin_user_id_element = 8
An optional Kin User ID Element
optional user_type_element = 9
An optional User Type Element
message
entity_service.proto:324Used in: , ,
oneof jid_type
Making this a oneof to future proof it
alias_jid = 1
Used in:
OK = 0
NOT_ALLOWED = 1
Token inconsistent with info on server
DELAYED = 2
Roster data is not ready, client should delay for 10 mins and try again.