Protocol Documentation

Table of Contents

• search.proto

  • GetSocietyIn

  • GetSocietyOut

  • GetSocietyWithLimitIn

  • GetSocietyWithLimitOut

  • GetUserWithLimitIn

  • GetUserWithLimitOut

  • SearchSociety

  • SocietySr

  • UserSr

  • SearchService

• Scalar Value Types

Top

search.proto

GetSocietyIn

Данные запроса собществ

Field	Type	Label	Description
part_name	string		полное имя сообщества или часть имени, по которому будет осуществлен поиск
limit	int64
offset	int64

GetSocietyOut

Объект ответа на запрос поиска

Field	Type	Label	Description
societies	SearchSociety	repeated	Массив объектов сообществ, удовлетворяющих поску
total	int64		Общее количество сообществ

GetSocietyWithLimitIn

Field	Type	Label	Description
limit	int64		количество запрашиваемых записей
offset	int64		offset записей
name	string		название сообщества которое ищем

GetSocietyWithLimitOut

Field	Type	Label	Description
societies	SocietySr	repeated	срез сообществ
total	int64		Количество найденных сообществ

GetUserWithLimitIn

Объект запроса пользователей

Field	Type	Label	Description
limit	int64		количество запрашиваемых записей
offset	int64		offset записей
nickname	string		nickname пользователя которого ищем

GetUserWithLimitOut

Объект ответа на запрос пользователей

Field	Type	Label	Description
users	UserSr	repeated	Срез пользователей
total	int64		Количество найденных пользователей

SearchSociety

Объект описывающий сообщество

Field	Type	Label	Description
name	string		Имя сообщества
avatar_link	string		Аватарка сообщества
is_private	bool		Признак публичности сообщества
description	string		Описание сообщества

SocietySr

Field	Type	Label	Description
name	string		Название сообщества
avatar_link	string		Ссылка на аватарку сообщества
society_id	int64		ID сообщества
isMember	bool		Состоит ли пользователь в группе: true - cocтоит, false - не состоит
isPrivate	bool		Приватное сообщество: true - да, false - нет

UserSr

Объект пользователь

Field	Type	Label	Description
nickname	string		Ник пользователя
uuid	string		UUID пользователя
avatar_link	string		ссылка на последний аватар пользователя
name	string		имя пользователя
surname	string		фамилия пользователя
isFriend	bool		friend?

SearchService

Method Name	Request Type	Response Type	Description
GetSociety	.GetSocietyIn	.GetSocietyOut	Метод получения сообществ в поиске
GetUserWithLimit	.GetUserWithLimitIn	.GetUserWithLimitOut	Метод получения списка users
GetSocietyWithLimit	.GetSocietyWithLimitIn	.GetSocietyWithLimitOut	Метод получения списка society

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)