Protocol Documentation

Table of Contents

• skirobot/E2eeRobotService.proto
  • E2eeRobotService
• skirobot/EventNotification.proto
  • EventNotification
  • OnFriendManagerMsgReceived
  • OnGroupCreated
  • OnGroupManagerMsgReceived
  • OnGroupMembersAdded
  • OnGroupMembersRemoved
  • OnGroupMsgReceived
  • OnInited
  • OnOne2oneMsgReceived
  • OnOtherDeviceMsgReceived
  • OnSystemManagerMsgReceived
  • OnUserRegistered
  • OnUserUpdated
• skirobot/EventSubscription.proto
  • EventSubscription
• skirobot/RobotAddFriendRequest.proto
  • RobotAddFriendRequest
• skirobot/RobotAddGroupMembersRequest.proto
  • RobotAddGroupMembersRequest
• skirobot/RobotBlockFriendRequest.proto
  • RobotBlockFriendRequest
• skirobot/RobotCreateAccountRequest.proto
  • RobotCreateAccountRequest
• skirobot/RobotCreateGroupRequest.proto
  • RobotCreateGroupRequest
• skirobot/RobotDecryptFileRequest.proto
  • RobotDecryptFileRequest
• skirobot/RobotDecryptFileResponse.proto
  • RobotDecryptFileResponse
• skirobot/RobotEncryptFileRequest.proto
  • RobotEncryptFileRequest
• skirobot/RobotEncryptFileResponse.proto
  • RobotEncryptFileResponse
• skirobot/RobotGetFriendsRequest.proto
  • RobotGetFriendsRequest
• skirobot/RobotGetUserRequest.proto
  • RobotGetUserRequest
• skirobot/RobotInviteRequest.proto
  • RobotInviteRequest
• skirobot/RobotLoginRequest.proto
  • RobotLoginRequest
• skirobot/RobotLogoutRequest.proto
  • RobotLogoutRequest
• skirobot/RobotMemoFriendRequest.proto
  • RobotMemoFriendRequest
• skirobot/RobotMsgDTO.proto
  • RobotMsgDTO
• skirobot/RobotRemoveFriendRequest.proto
  • RobotRemoveFriendRequest
• skirobot/RobotRemoveGroupMembersRequest.proto
  • RobotRemoveGroupMembersRequest
• skirobot/RobotSendDecryptStatusRequest.proto
  • RobotSendDecryptStatusRequest
• skirobot/RobotSendDecryptStatusResponse.proto
  • RobotSendDecryptStatusResponse
• skirobot/RobotSendPlainMsgRequest.proto
  • RobotSendPlainMsgRequest
• skirobot/RobotSendSyncPlainMsgRequest.proto
  • RobotSendSyncPlainMsgRequest
• skirobot/RobotSendSyncPlainMsgResponse.proto
  • RobotSendSyncPlainMsgResponse
• skirobot/RobotUnBlockFriendRequest.proto
  • RobotUnBlockFriendRequest
• skirobot/RobotUpdatePushIdRequest.proto
  • RobotUpdatePushIdRequest
• skirobot/RobotUpdateUserNameRequest.proto
  • RobotUpdateUserNameRequest
• Scalar Value Types

Top

skirobot/E2eeRobotService.proto

E2eeRobotService

Method Name	Request Type	Response Type	Description
CreateAccount	RobotCreateAccountRequest	.e2ees.RegisterUserResponse	account
Login	RobotLoginRequest	.skiserver.LoginResponse
Logout	RobotLogoutRequest	.skiserver.LogoutResponse
Invite	RobotInviteRequest	.e2ees.InviteResponse	One2one
SendOne2oneMsg	RobotSendPlainMsgRequest	RobotMsgDTO
SendSyncMsg	RobotSendSyncPlainMsgRequest	RobotSendSyncPlainMsgResponse
CreateGroup	RobotCreateGroupRequest	.e2ees.CreateGroupResponse	Group
AddGroupMembers	RobotAddGroupMembersRequest	.e2ees.AddGroupMembersResponse
RemoveGroupMembers	RobotRemoveGroupMembersRequest	.e2ees.RemoveGroupMembersResponse
UpdateGroupName	.skiserver.UpdateGroupNameRequest	.skiserver.UpdateGroupNameResponse
JoinGroup	.skiserver.JoinGroupRequest	.skiserver.JoinGroupResponse
LeaveGroup	.e2ees.LeaveGroupRequest	.e2ees.LeaveGroupResponse
UpdateGroupManagers	.skiserver.UpdateGroupManagersRequest	.skiserver.UpdateGroupManagersResponse
SendGroupMsg	RobotSendPlainMsgRequest	RobotMsgDTO
AddFriend	RobotAddFriendRequest	.skiserver.AddFriendResponse	Friendship
RemoveFriend	RobotRemoveFriendRequest	.skiserver.RemoveFriendResponse
BlockFriend	RobotBlockFriendRequest	.skiserver.BlockFriendResponse
UnBlockFriend	RobotUnBlockFriendRequest	.skiserver.UnBlockFriendResponse
MemoFriend	RobotMemoFriendRequest	.skiserver.MemoFriendResponse
GetFriends	RobotGetFriendsRequest	.skiserver.GetFriendsResponse
GetUser	.skiserver.GetUserRequest	.skiserver.GetUserResponse
UpdatePushId	.skiserver.UpdatePushIdRequest	.skiserver.UpdatePushIdResponse	Settings
UpdateUserName	.skiserver.UpdateUserNameRequest	.skiserver.UpdateUserNameResponse
UpdateUserPrivacy	.skiserver.UpdateUserPrivacyRequest	.skiserver.UpdateUserPrivacyResponse
SendDecryptStatusMsg	RobotSendDecryptStatusRequest	RobotSendDecryptStatusResponse	Misc
EncryptFile	RobotEncryptFileRequest	RobotEncryptFileResponse
DecryptFile	RobotDecryptFileRequest	RobotDecryptFileResponse
Subscribe	EventSubscription	EventNotification stream	server streaming operations

Top

skirobot/EventNotification.proto

EventNotification

Message for event notification from subscription service.

Field	Type	Label	Description
inited	OnInited
user_registered	OnUserRegistered
group_created	OnGroupCreated
group_members_added	OnGroupMembersAdded
group_members_removed	OnGroupMembersRemoved
user_updated	OnUserUpdated
one2one_msg_received	OnOne2oneMsgReceived
other_device_msg_received	OnOtherDeviceMsgReceived
group_msg_received	OnGroupMsgReceived
friend_manager_msg_received	OnFriendManagerMsgReceived
group_manager_msg_received	OnGroupManagerMsgReceived
system_manager_msg_received	OnSystemManagerMsgReceived

OnFriendManagerMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
friend_manager_msg	e2ees.FriendManagerMsg

OnGroupCreated

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
group_address	e2ees.E2eeAddress
group_name	string
group_member_list	e2ees.GroupMember	repeated

OnGroupManagerMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
group_manager_msg	e2ees.GroupManagerMsg

OnGroupMembersAdded

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
group_address	e2ees.E2eeAddress
group_name	string
group_member_list	e2ees.GroupMember	repeated
added_group_member_list	e2ees.GroupMember	repeated

OnGroupMembersRemoved

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
group_address	e2ees.E2eeAddress
group_name	string
group_member_list	e2ees.GroupMember	repeated
removed_group_member_list	e2ees.GroupMember	repeated

OnGroupMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
plain_msg	ski.PlainMsg

OnInited

OnOne2oneMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
plain_msg	ski.PlainMsg

OnOtherDeviceMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
plain_msg	ski.PlainMsg

OnSystemManagerMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
system_manager_msg	e2ees.SystemManagerMsg

OnUserRegistered

Field	Type	Label	Description
user_address	e2ees.E2eeAddress

OnUserUpdated

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
update_user_msg	e2ees.UpdateUserMsg

Top

skirobot/EventSubscription.proto

EventSubscription

Top

skirobot/RobotAddFriendRequest.proto

RobotAddFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotAddGroupMembersRequest.proto

RobotAddGroupMembersRequest

Field	Type	Label	Description
to_group	string
adding_members	e2ees.GroupMember	repeated

Top

skirobot/RobotBlockFriendRequest.proto

RobotBlockFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotCreateAccountRequest.proto

RobotCreateAccountRequest

Field	Type	Label	Description
username	string
user_id	string
authenticator	string
auth_code	string

Top

skirobot/RobotCreateGroupRequest.proto

RobotCreateGroupRequest

Field	Type	Label	Description
group_name	string
group_members	e2ees.GroupMember	repeated

Top

skirobot/RobotDecryptFileRequest.proto

RobotDecryptFileRequest

Request for decrypting file.

Field	Type	Label	Description
passkey	bytes
in_file_path	string

Top

skirobot/RobotDecryptFileResponse.proto

RobotDecryptFileResponse

Response for decrypting a file.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code given by the server.
msg	string		The message given by the server.
url	string		The url for decrypted file.

Top

skirobot/RobotEncryptFileRequest.proto

RobotEncryptFileRequest

Request for encrypting file.

Field	Type	Label	Description
passkey	bytes
in_file_path	string

Top

skirobot/RobotEncryptFileResponse.proto

RobotEncryptFileResponse

Response for encrypting a file.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code given by the server.
msg	string		The message given by the server.
url	string		The url for encrypted file.

Top

skirobot/RobotGetFriendsRequest.proto

RobotGetFriendsRequest

Top

skirobot/RobotGetUserRequest.proto

RobotGetUserRequest

Field	Type	Label	Description
user_address	string

Top

skirobot/RobotInviteRequest.proto

RobotInviteRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotLoginRequest.proto

RobotLoginRequest

Field	Type	Label	Description
user_address	string

Top

skirobot/RobotLogoutRequest.proto

RobotLogoutRequest

Top

skirobot/RobotMemoFriendRequest.proto

RobotMemoFriendRequest

Field	Type	Label	Description
to_user	string
memoname	string

Top

skirobot/RobotMsgDTO.proto

RobotMsgDTO

Field	Type	Label	Description
po_id	string

Top

skirobot/RobotRemoveFriendRequest.proto

RobotRemoveFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotRemoveGroupMembersRequest.proto

RobotRemoveGroupMembersRequest

Field	Type	Label	Description
to_group	string
removing_members	e2ees.GroupMember	repeated

Top

skirobot/RobotSendDecryptStatusRequest.proto

RobotSendDecryptStatusRequest

Field	Type	Label	Description
to	string
msg_ids	string	repeated

Top

skirobot/RobotSendDecryptStatusResponse.proto

RobotSendDecryptStatusResponse

Field	Type	Label	Description
code	e2ees.ResponseCode
msg	string

Top

skirobot/RobotSendPlainMsgRequest.proto

RobotSendPlainMsgRequest

Send a group or one2one plainMsg.

Field	Type	Label	Description
plain_msg	ski.PlainMsg
notif_level	e2ees.NotifLevel

Top

skirobot/RobotSendSyncPlainMsgRequest.proto

RobotSendSyncPlainMsgRequest

Send a sync plainMsg.

Field	Type	Label	Description
plain_msg	ski.PlainMsg

Top

skirobot/RobotSendSyncPlainMsgResponse.proto

RobotSendSyncPlainMsgResponse

Response for sending a sync plainMsg.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

skirobot/RobotUnBlockFriendRequest.proto

RobotUnBlockFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotUpdatePushIdRequest.proto

RobotUpdatePushIdRequest

Field	Type	Label	Description
push_id	string

Top

skirobot/RobotUpdateUserNameRequest.proto

RobotUpdateUserNameRequest

Field	Type	Label	Description
username	string

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)