Package: skiserver
The skiserver package is the protobuf designed for communicating with backend grpc messaging service.
skiserver/AcquireAuthCodeRequest.proto
AcquireAuthCodeRequest
Request for acquiring auth code.
Field | Type | Label | Description |
---|---|---|---|
authenticator | string | Email (mailto:xxx@xxx) or maybe mobile phone number (tel:xxx@xxx) to receive auth code. |
skiserver/AcquireAuthCodeResponse.proto
AcquireAuthCodeResponse
Response for acquiring auth code.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
ttl | int32 | Time to live (seconds) for auth code that has |
skiserver/AcquireGroupMemberInfosRequest.proto
AcquireGroupMemberInfosRequest
Request for acquiring group member info list.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | User address with userId and domain. |
skiserver/AcquireGroupMemberInfosResponse.proto
AcquireGroupMemberInfosResponse
Response for acquiring sign public key of uploaded identity public key.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
group_member_infos | e2ees.GroupMemberInfo | repeated | List of groupMemberInfo that consists of sign public key of uploaded identity public key. |
skiserver/AcquireServerInfoRequest.proto
AcquireServerInfoRequest
Request for acquiring server info.
Field | Type | Label | Description |
---|---|---|---|
heartbeat | e2ees.ClientHeartbeatMsg | Send the heartbeat msg to server. |
skiserver/AcquireServerInfoResponse.proto
AcquireServerInfoResponse
Response for acquiring server info.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
heartbeat | e2ees.ServerHeartbeatMsg |
skiserver/AddFriendRequest.proto
AddFriendRequest
Request for adding a friend.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The e2ee address for user who sends this request. | |
to_user | string | The simple e2ee address of user who will be added as a friend. | |
from_user | string | The simple e2ee address of user who is adding toUser as a friend. | |
from_username | string | The name of user who is adding toUser as a friend. |
skiserver/AddFriendResponse.proto
AddFriendResponse
Response for adding a friend.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
status | AddAttentionStatus | The friendship status. | |
friend | e2ees.FriendshipDTO | The friendship data. |
AddAttentionStatus
The friendship status.
Name | Number | Description |
---|---|---|
ADD_ATTENTION_STATUS_REJECTED | 0 | |
ADD_ATTENTION_STATUS_ATTENTION_ADDED | 1 | |
ADD_ATTENTION_STATUS_FRIEND_ADDED | 2 | |
ADD_ATTENTION_STATUS_ALREADY_ATTENDED | 3 | |
ADD_ATTENTION_STATUS_ALREADY_FRIENDED | 4 | |
ADD_ATTENTION_STATUS_REMOVE_BLOCKED | 5 | |
ADD_ATTENTION_STATUS_EXCEPTION | 6 |
skiserver/AskUserIdAvailableRequest.proto
AskUserIdAvailableRequest
Request for checking if a userId is available.
Field | Type | Label | Description |
---|---|---|---|
user_id | string | The userId to be registered. |
skiserver/AskUserIdAvailableResponse.proto
AskUserIdAvailableResponse
Response for checking if a userId is available.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/BackupMsgRequest.proto
BackupMsgRequest
Request for backing up a message.
Field | Type | Label | Description |
---|---|---|---|
backup_msg | MsgBackupDTO | The backup data. |
skiserver/BackupMsgResponse.proto
BackupMsgResponse
Response for backing up a message.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
time_backup | int64 | The back up time of the backup msg. |
skiserver/BackupPasskey.proto
BackupPasskey
Message for BackupPasskey.
Field | Type | Label | Description |
---|---|---|---|
passkeys | BackupPasskeyItem | repeated | A list of passkey items. |
BackupPasskeyItem
Message for BackupPasskeyItem.
Field | Type | Label | Description |
---|---|---|---|
ver | int32 | ||
e2ee_pack_id | uint32 | The e2ee pack ID used for this passkey. | |
index | int32 | The index of passkey item start from 0. | |
passkey | bytes | The passkey for backing up msg. | |
passkey_fingerprint | bytes | The hash value as the fingerprint of passkey. | |
signing_private_key | bytes | The private key data for signing backup msg. | |
signing_public_key | bytes | The public key data for verifying backup msg. | |
signing_public_key_fingerprint | bytes | The hash value as the fingerprint of the signing public key. |
skiserver/BlockFriendRequest.proto
BlockFriendRequest
Request for blocking a friend.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The e2ee address for user who sends this request. | |
to_user | string | The simple e2ee address for a user to be blocked. | |
from_user | string | The simple e2ee address for the user who is blocking toUser. |
skiserver/BlockFriendResponse.proto
BlockFriendResponse
Response for blocking a friend.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friend | e2ees.FriendshipDTO | The updated friendship data. |
skiserver/E2eeBackupService.proto
E2eeBackupService
The backup unary grpc service.
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetMsgBackupTs | GetMsgBackupTsRequest | GetMsgBackupTsResponse | |
BackupMsg | BackupMsgRequest | BackupMsgResponse | |
RecoverMsg | RecoverMsgRequest | RecoverMsgResponse |
skiserver/E2eeBidiService.proto
E2eeBidiService
The e2ee bidirection stream grpc service.
Method Name | Request Type | Response Type | Description |
---|---|---|---|
Communicate | .e2ees.ProtoMsg stream | .e2ees.ProtoMsg stream | bidi streaming operations |
skiserver/E2eeS2SService.proto
E2eeS2SService
The e2ee server to server unary grpc service.
skiserver/E2eeUnaryService.proto
E2eeUnaryService
The e2ee unary grpc service.
skiserver/FindUserRequest.proto
FindUserRequest
Request for finding user.
Field | Type | Label | Description |
---|---|---|---|
query | string | url-encoded string such as: userId%3Dxxx%26domain%3Dxxxx or authenticator%3Duser%40example.com. | |
user_address | e2ees.E2eeAddress | The address of the user who us sending this request. |
skiserver/FindUserResponse.proto
FindUserResponse
Response for finding a user.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friend | e2ees.FriendshipDTO | The friendship data of a retrieved user. |
skiserver/GetFriendsRequest.proto
GetFriendsRequest
Request for getting friendship data.
Field | Type | Label | Description |
---|---|---|---|
last_modified_date | int64 | The latest modified time stamp of friendship in client side. |
skiserver/GetFriendsResponse.proto
GetFriendsResponse
Response for getting friendship data.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friends | e2ees.FriendshipDTO | repeated | The list of friendship data. |
skiserver/GetMsgBackupTsRequest.proto
GetMsgBackupTsRequest
Request for acquiring time stamps of backed up msgs.
Field | Type | Label | Description |
---|---|---|---|
msg_ids | string | repeated | The array of msg ids to be queried. |
skiserver/GetMsgBackupTsResponse.proto
GetMsgBackupTsResponse
Response for acquiring time stamps of backed up msgs.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
backup_tses | MsgBackupTsDTO | repeated | The array of backup time stamps. |
skiserver/GetUserRequest.proto
GetUserRequest
Request for retrieving information of a user.
Field | Type | Label | Description |
---|---|---|---|
to_user | string | The simple e2ee address for the user whose information is retrieved. | |
user_address | e2ees.E2eeAddress | The address of the user who is retrieving the information of toUser. |
skiserver/GetUserResponse.proto
GetUserResponse
Response for retrieving information of a user.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friend | e2ees.FriendshipDTO | The friendship data of a retrieved user. |
skiserver/JoinGroupRequest.proto
JoinGroupRequest
Request for joining a group.
Field | Type | Label | Description |
---|---|---|---|
to_group | string | The simple e2ee address of the joining group. | |
user_address | e2ees.E2eeAddress | The address of the user joining the group |
skiserver/JoinGroupResponse.proto
JoinGroupResponse
Response for joining a group.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/JwtToken.proto
JwtToken
Message for jwt token.
Field | Type | Label | Description |
---|---|---|---|
token | string | The token. | |
expires_in | int64 | The expiry time. |
skiserver/LoginRequest.proto
LoginRequest
Request for login.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The user e2ee address for whom is going to login. | |
password | string | The password to login the e2ee service. |
skiserver/LoginResponse.proto
LoginResponse
Response for login.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
auth | string | The updated authorization code. | |
expires_in | int64 | The time of expiration for the authorization code. | |
user_state | ski.UserState | The user state. | |
msgBackup_device_id | string | The optional main backup deviceId. |
skiserver/LogoutRequest.proto
LogoutRequest
Request for logout.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The user e2ee address (with device id) for whom is going to logout. |
skiserver/LogoutResponse.proto
LogoutResponse
Response for logout.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/MemoFriendRequest.proto
MemoFriendRequest
Request for giving a memo name to a friend.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The e2ee address for user who sends this request. | |
to_user | string | The simple e2ee address for the user who is giving a memo name. | |
memoname | string | The memo name (max len = 12 utf-8 chars). |
skiserver/MemoFriendResponse.proto
MemoFriendResponse
Response for giving a memo name to a friend.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friend | e2ees.FriendshipDTO | The updated friendship data. |
skiserver/MsgBackupDTO.proto
MsgBackupDTO
Message for a backup msg.
Field | Type | Label | Description |
---|---|---|---|
msg_id | string | The msgId of the backup msg. | |
time_send | int64 | The time of the backup msg that was sent. | |
time_backup | int64 | The back up time of the backup msg. | |
passkey_fingerprint | bytes | The passkey fingerprint for the backup msg. | |
signing_public_key_fingerprint | bytes | The hash value as the fingerprint of the signing public key. | |
encrypted_msg | bytes | The encrypted backup msg. | |
plain_msg_signature | bytes | The signature of plain msg to be backed up. | |
encrypted_attachment | bytes | The optional encrypted attachment data of the backup msg. | |
plain_attachment_signature | bytes | The optional signature of plain attachment data to be backed up. |
skiserver/MsgBackupTsDTO.proto
MsgBackupTsDTO
Message for the time stamp of a backed up msg.
Field | Type | Label | Description |
---|---|---|---|
msg_id | string | The msgId of the backup msg. | |
time_send | int64 | The time of the backup msg that was sent. | |
time_backup | int64 | The time of the backup msg that was backed up. |
skiserver/NotifyCertUpdateRequest.proto
NotifyCertUpdateRequest
Request for notifying certificates update.
Field | Type | Label | Description |
---|---|---|---|
ts | int64 | The lastest time stamp for current list of certificates. |
skiserver/NotifyCertUpdateResponse.proto
NotifyCertUpdateResponse
Response for notifying certificates update.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/RecoverMsgRequest.proto
RecoverMsgRequest
Request for recovering some backed up msgs.
Field | Type | Label | Description |
---|---|---|---|
last_msg_id | string | Optional last msgId that has been downloaded previously. | |
last_time_send | int64 | Optional last timestamp for a sent msg. | |
limit | int32 | The maximal number of messages to be downloaded. (max 500) |
skiserver/RecoverMsgResponse.proto
RecoverMsgResponse
Response for recovering backed up msgs.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
backuped_msgs | MsgBackupDTO | repeated | The recovered data. |
skiserver/RemoveFriendRequest.proto
RemoveFriendRequest
Request for removing a friend.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The e2ee address for user who sends this request. | |
to_user | string | The simple e2ee address of user who will be removed as a friend. | |
from_user | string | The simple e2ee address of user who is removing toUser from contacts. |
skiserver/RemoveFriendResponse.proto
RemoveFriendResponse
Response for removing a friend.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friend | e2ees.FriendshipDTO | The updated friendship data. |
skiserver/RemoveUserDeviceRequest.proto
RemoveUserDeviceRequest
Request for removing a user device.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The e2ee address for user who sends this request. | |
remove_user_device_msg | e2ees.RemoveUserDeviceMsg | The remove_user_device_msg. |
skiserver/RemoveUserDeviceResponse.proto
RemoveUserDeviceResponse
Response for removing a user device.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/ServerAcquireLoginRequest.proto
ServerAcquireLoginRequest
Request for acquiring server login challenge.
Field | Type | Label | Description |
---|---|---|---|
domain | string | The domain. |
skiserver/ServerAcquireLoginResponse.proto
ServerAcquireLoginResponse
Response for acquiring server login challenge..
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
challenge | string | The chanllenge base64 string. |
skiserver/ServerLoginRequest.proto
ServerLoginRequest
Request for server login.
Field | Type | Label | Description |
---|---|---|---|
domain | string | The domain. | |
certFingerprint | bytes | The certFingerprint for the certificate that can be used to verify the response; | |
challenge | string | The challenge base64 string. | |
response | string | The base64 string that is the signature created by signing the challenge with server's key. |
skiserver/ServerLoginResponse.proto
ServerLoginResponse
Response for server login.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
cn | string | The common name. | |
domain | string | The domain. | |
access_token | JwtToken | The access token. | |
refresh_token | JwtToken | The refresh token. |
skiserver/ServerRefreshTokenRequest.proto
ServerRefreshTokenRequest
The request for refreshing server token.
Field | Type | Label | Description |
---|---|---|---|
domain | string | The domain. | |
refresh_token | string | The refresh token. |
skiserver/ServerRefreshTokenResponse.proto
ServerRefreshTokenResponse
The response for refreshing server token.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
access_token | JwtToken | The accessToken for 30 days. | |
refresh_token | JwtToken | The refreshToken for 180 days. |
skiserver/SubmitProtoMsgRequest.proto
SubmitProtoMsgRequest
Request for submitting protoMsg to a s2s service.
Field | Type | Label | Description |
---|---|---|---|
protoMsg | e2ees.ProtoMsg | The protoMsg to be delivered. | |
ignoredDeviceIdList | string | repeated | Optional ignored deviceId list. |
skiserver/SubmitProtoMsgResponse.proto
SubmitProtoMsgResponse
Response for submitting protoMsg to a s2s service.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/UnBlockFriendRequest.proto
UnBlockFriendRequest
Request for unblocking a friend.
Field | Type | Label | Description |
---|---|---|---|
user_address | e2ees.E2eeAddress | The e2ee address for user who sends this request. | |
to_user | string | The simple e2ee address for a user to be unblocked. | |
from_user | string | The simple e2ee address for the user who is unblocking toUser. |
skiserver/UnBlockFriendResponse.proto
UnBlockFriendResponse
Response for unblocking a friend.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
friend | e2ees.FriendshipDTO | The updated friendship data. |
skiserver/UpdateAuthenticatorRequest.proto
UpdateAuthenticatorRequest
Request for updating authenticator.
Field | Type | Label | Description |
---|---|---|---|
authenticator | string | Email (mailto:xxx@xxx) or mobile phone number (tel:xxx@xxx) to receive auth code. | |
auth_code | string | The auth code received from authenticator. |
skiserver/UpdateAuthenticatorResponse.proto
UpdateAuthenticatorResponse
Response for updating authenticator.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/UpdateGroupManagersRequest.proto
UpdateGroupManagersRequest
Request for updating group managers.
Field | Type | Label | Description |
---|---|---|---|
to_group | string | The simple e2ee address of the updating group. | |
from_user | string | The simple e2ee address of the user who is updating the group. | |
updating_members | e2ees.GroupMember | repeated | The list of updated group members with new roles. |
skiserver/UpdateGroupManagersResponse.proto
UpdateGroupManagersResponse
Response for updating group managers.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. | |
group_managers | e2ees.GroupMember | repeated | The list of new group managers. |
skiserver/UpdateGroupNameRequest.proto
UpdateGroupNameRequest
Request for renaming a group.
Field | Type | Label | Description |
---|---|---|---|
to_group | string | The simple e2ee address of the renaming group. | |
from_user | string | The simple e2ee address of the user who is renaming the group. | |
group_name | string | The group name. |
skiserver/UpdateGroupNameResponse.proto
UpdateGroupNameResponse
Response for renaming a group.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/UpdatePushIdRequest.proto
UpdatePushIdRequest
Request for updating pushId.
Field | Type | Label | Description |
---|---|---|---|
push_id | string | The pushId for push notification. | |
type | PushIDType | The optional pushId type. |
PushIDType
Name | Number | Description |
---|---|---|
PUSH_ID_TYPE_NORMAL | 0 | PushId for general circumstances. |
PUSH_ID_TYPE_APNS_VOIP | 1 | PushId for apns voip. |
skiserver/UpdatePushIdResponse.proto
UpdatePushIdResponse
Response for updating pushId.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/UpdateUserNameRequest.proto
UpdateUserNameRequest
Request for updating user name.
Field | Type | Label | Description |
---|---|---|---|
username | string | The user name (max len = 12 utf-8 chars). |
skiserver/UpdateUserNameResponse.proto
UpdateUserNameResponse
Response for updating user name.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |
skiserver/UpdateUserPrivacyRequest.proto
UpdateUserPrivacyRequest
Request for updating user privacy.
Field | Type | Label | Description |
---|---|---|---|
allow_attention | bool | Allow being added as a friend. | |
allow_greeting | bool | Allow receiving msg from strangers. | |
allow_auto_friend | bool | Allow adding friend automatically when someone is adding user as friend. |
skiserver/UpdateUserPrivacyResponse.proto
UpdateUserPrivacyResponse
Response for updating user privacy.
Field | Type | Label | Description |
---|---|---|---|
code | e2ees.ResponseCode | The response code. | |
msg | string | Optional response message. |