Package: skiserver

The skiserver package is the protobuf designed for communicating with backend grpc messaging service.

Top

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.

Top

skiserver/AcquireAuthCodeResponse.proto

AcquireAuthCodeResponse

Response for acquiring auth code.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
ttl	int32		Time to live (seconds) for auth code that has

Top

skiserver/AcquireGroupMemberInfosRequest.proto

AcquireGroupMemberInfosRequest

Request for acquiring group member info list.

Field	Type	Label	Description
user_address	skissm.E2eeAddress		User address with userId and domain.

Top

skiserver/AcquireGroupMemberInfosResponse.proto

AcquireGroupMemberInfosResponse

Response for acquiring sign public key of uploaded identity public key.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
group_member_infos	skissm.GroupMemberInfo	repeated	List of groupMemberInfo that consists of sign public key of uploaded identity public key.

Top

skiserver/AcquireServerInfoRequest.proto

AcquireServerInfoRequest

Request for acquiring server info.

Field	Type	Label	Description
heartbeat	skissm.ClientHeartbeatMsg		Send the heartbeat msg to server.

Top

skiserver/AcquireServerInfoResponse.proto

AcquireServerInfoResponse

Response for acquiring server info.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
heartbeat	skissm.ServerHeartbeatMsg

Top

skiserver/AddFriendRequest.proto

AddFriendRequest

Request for adding a friend.

Field	Type	Label	Description
user_address	skissm.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.

Top

skiserver/AddFriendResponse.proto

AddFriendResponse

Response for adding a friend.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
status	AddAttentionStatus		The friendship status.
friend	skissm.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

Top

skiserver/AskUserIdAvailableRequest.proto

AskUserIdAvailableRequest

Request for checking if a userId is available.

Field	Type	Label	Description
user_id	string		The userId to be registered.

Top

skiserver/AskUserIdAvailableResponse.proto

AskUserIdAvailableResponse

Response for checking if a userId is available.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/BackupMsgRequest.proto

BackupMsgRequest

Request for backing up a message.

Field	Type	Label	Description
backup_msg	MsgBackupDTO		The backup data.

Top

skiserver/BackupMsgResponse.proto

BackupMsgResponse

Response for backing up a message.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/BlockFriendRequest.proto

BlockFriendRequest

Request for blocking a friend.

Field	Type	Label	Description
user_address	skissm.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.

Top

skiserver/BlockFriendResponse.proto

BlockFriendResponse

Response for blocking a friend.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friend	skissm.FriendshipDTO		The updated friendship data.

Top

skiserver/DownloadMsgRequest.proto

DownloadMsgRequest

Request for downloading a backed up msg.

Field	Type	Label	Description
user_address	string		The simple e2ee address of a user.
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)

Top

skiserver/DownloadMsgResponse.proto

DownloadMsgResponse

Response for downloading a backed up msg.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
backuped_msgs	MsgBackupDTO	repeated	The downloaded data.

Top

skiserver/E2eeBackupService.proto

E2eeBackupService

The backup unary grpc service.

Method Name	Request Type	Response Type	Description
BackupMsg	BackupMsgRequest	BackupMsgResponse
DownloadMsg	DownloadMsgRequest	DownloadMsgResponse
UpdateMsgBackupKey	UpdateMsgBackupKeyRequest	UpdateMsgBackupKeyResponse

Top

skiserver/E2eeBidiService.proto

E2eeBidiService

The e2ee bidirection stream grpc service.

Method Name	Request Type	Response Type	Description
Communicate	.skissm.ProtoMsg stream	.skissm.ProtoMsg stream	bidi streaming operations

Top

skiserver/E2eeS2SService.proto

E2eeS2SService

The e2ee server to server unary grpc service.

Method Name	Request Type	Response Type	Description
GetPreKeyBundle	.skissm.GetPreKeyBundleRequest	.skissm.GetPreKeyBundleResponse
Invite	.skissm.InviteRequest	.skissm.InviteResponse
SendOne2oneMsg	.skissm.SendOne2oneMsgRequest	.skissm.SendOne2oneMsgResponse
GetUser	GetUserRequest	GetUserResponse
RemoveUserDevice	RemoveUserDeviceRequest	RemoveUserDeviceResponse
AddFriend	AddFriendRequest	AddFriendResponse
RemoveFriend	RemoveFriendRequest	RemoveFriendResponse
BlockFriend	BlockFriendRequest	BlockFriendResponse
UnBlockFriend	UnBlockFriendRequest	UnBlockFriendResponse
AddGroupMembers	.skissm.AddGroupMembersRequest	.skissm.AddGroupMembersResponse
AddGroupMemberDevice	.skissm.AddGroupMemberDeviceRequest	.skissm.AddGroupMemberDeviceResponse
RemoveGroupMembers	.skissm.RemoveGroupMembersRequest	.skissm.RemoveGroupMembersResponse
JoinGroup	JoinGroupRequest	JoinGroupResponse
LeaveGroup	.skissm.LeaveGroupRequest	.skissm.LeaveGroupResponse
UpdateGroupName	UpdateGroupNameRequest	UpdateGroupNameResponse
UpdateGroupManagers	UpdateGroupManagersRequest	UpdateGroupManagersResponse
GetGroup	.skissm.GetGroupRequest	.skissm.GetGroupResponse
SendGroupMsg	.skissm.SendGroupMsgRequest	.skissm.SendGroupMsgResponse
AcquireGroupMemberInfos	AcquireGroupMemberInfosRequest	AcquireGroupMemberInfosResponse
SubmitProtoMsg	SubmitProtoMsgRequest	SubmitProtoMsgResponse

Top

skiserver/E2eeUnaryService.proto

E2eeUnaryService

The e2ee unary grpc service.

Method Name	Request Type	Response Type	Description
AcquireAuthCode	AcquireAuthCodeRequest	AcquireAuthCodeResponse
AskUserIdAvailable	AskUserIdAvailableRequest	AskUserIdAvailableResponse
RegisterUser	.skissm.RegisterUserRequest	.skissm.RegisterUserResponse
UpdateAuthenticator	UpdateAuthenticatorRequest	UpdateAuthenticatorResponse
Login	LoginRequest	LoginResponse
Logout	LogoutRequest	LogoutResponse
AcquireServerInfo	AcquireServerInfoRequest	AcquireServerInfoResponse
GetPreKeyBundle	.skissm.GetPreKeyBundleRequest	.skissm.GetPreKeyBundleResponse
Invite	.skissm.InviteRequest	.skissm.InviteResponse
Accept	.skissm.AcceptRequest	.skissm.AcceptResponse
PublishSpk	.skissm.PublishSpkRequest	.skissm.PublishSpkResponse
SupplyOpks	.skissm.SupplyOpksRequest	.skissm.SupplyOpksResponse
SendOne2oneMsg	.skissm.SendOne2oneMsgRequest	.skissm.SendOne2oneMsgResponse
AddFriend	AddFriendRequest	AddFriendResponse
RemoveFriend	RemoveFriendRequest	RemoveFriendResponse
BlockFriend	BlockFriendRequest	BlockFriendResponse
UnBlockFriend	UnBlockFriendRequest	UnBlockFriendResponse
MemoFriend	MemoFriendRequest	MemoFriendResponse
GetFriends	GetFriendsRequest	GetFriendsResponse
GetUser	GetUserRequest	GetUserResponse
FindUser	FindUserRequest	FindUserResponse
CreateGroup	.skissm.CreateGroupRequest	.skissm.CreateGroupResponse
AddGroupMembers	.skissm.AddGroupMembersRequest	.skissm.AddGroupMembersResponse
AddGroupMemberDevice	.skissm.AddGroupMemberDeviceRequest	.skissm.AddGroupMemberDeviceResponse
RemoveGroupMembers	.skissm.RemoveGroupMembersRequest	.skissm.RemoveGroupMembersResponse
JoinGroup	JoinGroupRequest	JoinGroupResponse
LeaveGroup	.skissm.LeaveGroupRequest	.skissm.LeaveGroupResponse
UpdateGroupName	UpdateGroupNameRequest	UpdateGroupNameResponse
UpdateGroupManagers	UpdateGroupManagersRequest	UpdateGroupManagersResponse
GetGroup	.skissm.GetGroupRequest	.skissm.GetGroupResponse
SendGroupMsg	.skissm.SendGroupMsgRequest	.skissm.SendGroupMsgResponse
UpdatePushId	UpdatePushIdRequest	UpdatePushIdResponse
UpdateUserName	UpdateUserNameRequest	UpdateUserNameResponse
UpdateUserPrivacy	UpdateUserPrivacyRequest	UpdateUserPrivacyResponse
ConsumeProtoMsg	.skissm.ConsumeProtoMsgRequest	.skissm.ConsumeProtoMsgResponse

Top

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	skissm.E2eeAddress		The address of the user who us sending this request.

Top

skiserver/FindUserResponse.proto

FindUserResponse

Response for finding a user.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friend	skissm.FriendshipDTO		The friendship data of a retrieved user.

Top

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.

Top

skiserver/GetFriendsResponse.proto

GetFriendsResponse

Response for getting friendship data.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friends	skissm.FriendshipDTO	repeated	The list of friendship data.

Top

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	skissm.E2eeAddress		The address of the user who is retrieving the information of toUser.

Top

skiserver/GetUserResponse.proto

GetUserResponse

Response for retrieving information of a user.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friend	skissm.FriendshipDTO		The friendship data of a retrieved user.

Top

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	skissm.E2eeAddress		The address of the user joining the group

Top

skiserver/JoinGroupResponse.proto

JoinGroupResponse

Response for joining a group.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/LoginRequest.proto

LoginRequest

Request for login.

Field	Type	Label	Description
user_address	skissm.E2eeAddress		The user e2ee address for whom is going to login.
password	string		The password to login the e2ee service.

Top

skiserver/LoginResponse.proto

LoginResponse

Response for login.

Field	Type	Label	Description
code	skissm.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.

Top

skiserver/LogoutRequest.proto

LogoutRequest

Request for logout.

Field	Type	Label	Description
user_address	skissm.E2eeAddress		The user e2ee address (with device id) for whom is going to logout.

Top

skiserver/LogoutResponse.proto

LogoutResponse

Response for logout.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/MemoFriendRequest.proto

MemoFriendRequest

Request for giving a memo name to a friend.

Field	Type	Label	Description
user_address	skissm.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).

Top

skiserver/MemoFriendResponse.proto

MemoFriendResponse

Response for giving a memo name to a friend.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friend	skissm.FriendshipDTO		The updated friendship data.

Top

skiserver/MsgBackupDTO.proto

MsgBackupDTO

Message for a backedup msg.

Field	Type	Label	Description
msg_id	string		The msgId of the backed up msg.
time_send	int64		The time of the backed up msg that was sent.
encrypted_data	bytes		The encrypted data of the backed up msg.

Top

skiserver/RemoveFriendRequest.proto

RemoveFriendRequest

Request for removing a friend.

Field	Type	Label	Description
user_address	skissm.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.

Top

skiserver/RemoveFriendResponse.proto

RemoveFriendResponse

Response for removing a friend.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friend	skissm.FriendshipDTO		The updated friendship data.

Top

skiserver/RemoveUserDeviceRequest.proto

RemoveUserDeviceRequest

Request for removing a user device.

Field	Type	Label	Description
user_address	skissm.E2eeAddress		The e2ee address for user who sends this request.
remove_user_device_msg	skissm.RemoveUserDeviceMsg		The remove_user_device_msg.

Top

skiserver/RemoveUserDeviceResponse.proto

RemoveUserDeviceResponse

Response for removing a user device.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/SubmitProtoMsgRequest.proto

SubmitProtoMsgRequest

Request for submitting protoMsg to a s2s service.

Field	Type	Label	Description
protoMsg	skissm.ProtoMsg		The protoMsg to be delivered.
ignoredDeviceIdList	string	repeated	Optional ignored deviceId list.

Top

skiserver/SubmitProtoMsgResponse.proto

SubmitProtoMsgResponse

Response for submitting protoMsg to a s2s service.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UnBlockFriendRequest.proto

UnBlockFriendRequest

Request for unblocking a friend.

Field	Type	Label	Description
user_address	skissm.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.

Top

skiserver/UnBlockFriendResponse.proto

UnBlockFriendResponse

Response for unblocking a friend.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
friend	skissm.FriendshipDTO		The updated friendship data.

Top

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.

Top

skiserver/UpdateAuthenticatorResponse.proto

UpdateAuthenticatorResponse

Response for updating authenticator.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

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	skissm.GroupMember	repeated	The list of updated group members with new roles.

Top

skiserver/UpdateGroupManagersResponse.proto

UpdateGroupManagersResponse

Response for updating group managers.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.
group_managers	skissm.GroupMember	repeated	The list of new group managers.

Top

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.

Top

skiserver/UpdateGroupNameResponse.proto

UpdateGroupNameResponse

Response for renaming a group.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UpdateMsgBackupKeyRequest.proto

UpdateMsgBackupKeyRequest

Request for updating msg backup key hash.

Field	Type	Label	Description
msg_backup_key_hash	bytes		The hash of new backup key.

Top

skiserver/UpdateMsgBackupKeyResponse.proto

UpdateMsgBackupKeyResponse

Response for updating msg backup key hash.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

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.

Top

skiserver/UpdatePushIdResponse.proto

UpdatePushIdResponse

Response for updating pushId.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UpdateUserNameRequest.proto

UpdateUserNameRequest

Request for updating user name.

Field	Type	Label	Description
username	string		The user name (max len = 12 utf-8 chars).

Top

skiserver/UpdateUserNameResponse.proto

UpdateUserNameResponse

Response for updating user name.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Top

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.

Top

skiserver/UpdateUserPrivacyResponse.proto

UpdateUserPrivacyResponse

Response for updating user privacy.

Field	Type	Label	Description
code	skissm.ResponseCode		The response code.
msg	string		Optional response message.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)