You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Protocol Documentation
Table of Contents
Top
store/activity.proto
ActivityShorcutCreatePayload
Field |
Type |
Label |
Description |
shortcut_id |
int32 |
|
|
ActivityShorcutViewPayload
Top
store/common.proto
RowStatus
Name |
Number |
Description |
ROW_STATUS_UNSPECIFIED |
0 |
|
NORMAL |
1 |
|
ARCHIVED |
2 |
|
Visibility
Name |
Number |
Description |
VISIBILITY_UNSPECIFIED |
0 |
|
PRIVATE |
1 |
|
WORKSPACE |
2 |
|
PUBLIC |
3 |
|
Top
store/collection.proto
Collection
Top
store/shortcut.proto
OpenGraphMetadata
Shortcut
Top
store/user_setting.proto
AccessTokensUserSetting
AccessTokensUserSetting.AccessToken
Field |
Type |
Label |
Description |
access_token |
string |
|
The access token is a JWT token. Including expiration time, issuer, etc. |
description |
string |
|
A description for the access token. |
UserSetting
ColorThemeUserSetting
Name |
Number |
Description |
COLOR_THEME_USER_SETTING_UNSPECIFIED |
0 |
|
SYSTEM |
1 |
|
LIGHT |
2 |
|
DARK |
3 |
|
LocaleUserSetting
Name |
Number |
Description |
LOCALE_USER_SETTING_UNSPECIFIED |
0 |
|
EN |
1 |
|
ZH |
2 |
|
FR |
3 |
|
UserSettingKey
Name |
Number |
Description |
USER_SETTING_KEY_UNSPECIFIED |
0 |
|
ACCESS_TOKENS |
1 |
Access tokens for the user. |
LOCALE |
2 |
Locale for the user. |
COLOR_THEME |
3 |
Color theme for the user. |
Top
store/workspace_setting.proto
AutoBackupWorkspaceSetting
Field |
Type |
Label |
Description |
enabled |
bool |
|
Whether auto backup is enabled. |
cron_expression |
string |
|
The cron expression for auto backup. For example, "0 0 0 * * *" means backup at 00:00:00 every day. See https://en.wikipedia.org/wiki/Cron for more details. |
max_keep |
int32 |
|
The maximum number of backups to keep. |
WorkspaceSetting
WorkspaceSettingKey
Name |
Number |
Description |
WORKSPACE_SETTING_KEY_UNSPECIFIED |
0 |
|
WORKSPACE_SETTING_LICENSE_KEY |
1 |
The license key. |
WORKSPACE_SETTING_SECRET_SESSION |
2 |
The secret session key used to encrypt session data. |
WORKSAPCE_SETTING_ENABLE_SIGNUP |
3 |
Whether to enable other users to sign up. |
WORKSPACE_SETTING_CUSTOM_STYLE |
4 |
The custom style. |
WORKSPACE_SETTING_CUSTOM_SCRIPT |
5 |
The custom script. |
WORKSPACE_SETTING_AUTO_BACKUP |
6 |
The auto backup setting. |
WORKSPACE_SETTING_INSTANCE_URL |
7 |
The instance URL. |
WORKSPACE_SETTING_DEFAULT_VISIBILITY |
8 |
The default visibility of shortcuts and collections. |
WORKSPACE_SETTING_FAVICON_PROVIDER |
9 |
The url of custom favicon provider. |
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) |