doc.md

Protocol 文档

目录

• pb/screen.proto

  • Services

    • Screen

  • Messages

    • AddScreenDataReq
    • AddScreenDataResp
    • AddScreenProjectReq
    • AddScreenProjectResp
    • DelScreenProjectReq
    • DelScreenProjectResp
    • ScreenData
    • ScreenProject
    • ScreenProjectFilter
    • SelectScreenDataByIdReq
    • SelectScreenDataByIdResp
    • SelectScreenProjectByIdReq
    • SelectScreenProjectByIdResp
    • SelectScreenProjectListReq
    • SelectScreenProjectListResp
    • UpdateScreenProjectReq
    • UpdateScreenProjectResp

• Scalar Value Types

Top

pb/screen.proto

AddScreenDataReq

Field	Type	Label	Description
project_id	int64		project ID
user_id	int64		用户 ID
content	string		内容数据

AddScreenDataResp

AddScreenProjectReq

Field	Type	Label	Description
name	string		大屏名称
state	int64		发布状态(-1 未发布 1 已发布)
user_id	int64		创建用户ID
index_img	string		缩略图
remark	string		备注
is_del	bool		是否删除(0 未删除 1 已删除)

AddScreenProjectResp

Field	Type	Label	Description
project	ScreenProject		screen_project

DelScreenProjectReq

Field	Type	Label	Description
id	int64		ID

DelScreenProjectResp

ScreenData

Field	Type	Label	Description
id	int64		ID
project_id	int64		project ID
user_id	int64		用户 ID
content	string		内容数据
create_at	int64		创建时间

ScreenProject

Field	Type	Label	Description
id	int64		ID
name	string		大屏名称
state	int64		发布状态(-1 未发布 1 已发布)
user_id	int64		创建用户ID
index_img	string		缩略图
remark	string		备注
is_del	bool		是否删除(0 未删除 1 已删除)
create_at	int64		创建时间

ScreenProjectFilter

Field	Type	Label	Description
id	int64	optional	ID
name	string	optional	大屏名称
state	int64	optional	发布状态(-1 未发布 1 已发布)
user_id	int64	optional	创建用户ID
index_img	string	optional	缩略图
remark	string	optional	备注
is_del	bool	optional	是否删除(0 未删除 1 已删除)
create_at	int64	optional	创建时间

SelectScreenDataByIdReq

Field	Type	Label	Description
id	int64		ID
project_id	int64		project ID

SelectScreenDataByIdResp

Field	Type	Label	Description
screen_data	ScreenData		screen_data

SelectScreenProjectByIdReq

Field	Type	Label	Description
id	int64		ID

SelectScreenProjectByIdResp

Field	Type	Label	Description
screen_project	ScreenProject		screen_project

SelectScreenProjectListReq

Field	Type	Label	Description
page	int64		页码
page_size	int64		每页数量
filter	ScreenProjectFilter		ScreenProjectFilter

SelectScreenProjectListResp

Field	Type	Label	Description
count	int64		总数
page_count	int64		页码总数
results	ScreenProject	repeated	screen_project

UpdateScreenProjectReq

Field	Type	Label	Description
id	int64		ID
name	string	optional	大屏名称
state	int64	optional	发布状态(-1 未发布 1 已发布)
user_id	int64	optional	创建用户ID
index_img	string	optional	缩略图
remark	string	optional	备注
is_del	bool	optional	是否删除(0 未删除 1 已删除)

UpdateScreenProjectResp

Screen

Method Name	Request Type	Response Type	Description
InsertScreenProject	AddScreenProjectReq	AddScreenProjectResp	创建大屏信息
UpdateScreenProject	UpdateScreenProjectReq	UpdateScreenProjectResp	更新大屏信息
DeleteScreenProject	DelScreenProjectReq	DelScreenProjectResp	根据大屏信息ID删除
SelectScreenProjectById	SelectScreenProjectByIdReq	SelectScreenProjectByIdResp	根据大屏信息ID获取详情
SelectScreenProjectList	SelectScreenProjectListReq	SelectScreenProjectListResp	大屏信息列表
InsertScreenData	AddScreenDataReq	AddScreenDataResp	创建大屏数据
SelectScreenDataById	SelectScreenDataByIdReq	SelectScreenDataByIdResp	根据大屏数据ID获取详情

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)