package clapshot.organizer
Get desktop application:
View/edit binary Protocol Buffers messages
Calls that Clapshot server makes to Organizer
rpc check_migrations (, )
organizer.proto:55Initialization calls (in the order they are made)
message
organizer.proto:158optional db = 1
message
organizer.proto:161string name = 1
Name of the organizer module (see OrganizerInfo)
string current_schema_ver = 2
Current (last applied) migration version
repeated pending_migrations = 3
List of pending (alternative) migrations.
rpc apply_migration (, )
organizer.proto:56message
organizer.proto:169optional db = 1
Database to apply the migration to. Organizer MUST NOT store the connection, but release it after the call.
string uuid = 2
UUID of the migration to apply (from CheckMigrationResponse)
message
organizer.proto:173(message has no fields)
rpc handshake (, )
organizer.proto:57message
organizer.proto:91optional version = 1
optional storage = 3
string url_base = 4
optional db = 5
optional backchannel = 6
User session events
message
organizer.proto:190optional ses = 1
message
organizer.proto:194(message has no fields)
rpc navigate_page (, )
organizer.proto:68message
organizer.proto:196optional ses = 1
optional string page_id = 2
rpc authz_user_action (, )
organizer.proto:69message
organizer.proto:220optional ses = 1
oneof op
other_op = 8
media_file_op = 9
comment_op = 10
message
organizer.proto:262optional bool is_authorized = 1
If not set, leave authorization decision to server
optional string message = 2
e.g. "You are not authorized to view this media file"
optional string details = 3
e.g. "You are not a member of the project"
rpc cmd_from_client (, )
organizer.proto:70message
organizer.proto:201optional ses = 1
string cmd = 2
string args = 3
Arbitrary data from your own Action handler that is executed on the client
rpc move_to_folder (, )
organizer.proto:73Calls from client when user interacts with the folder UI
message
organizer.proto:207optional ses = 1
repeated ids = 2
string dst_folder_id = 3
map<string, string> listing_data = 4
rpc reorder_items (, )
organizer.proto:74message
organizer.proto:214optional ses = 1
repeated ids = 2
map<string, string> listing_data = 3
rpc list_tests (, )
organizer.proto:77Unit / integration tests (not called in production)
message
organizer.proto:270repeated string test_names = 1
rpc run_test (, )
organizer.proto:78message
organizer.proto:274string test_name = 1
message
organizer.proto:278string output = 1
optional string error = 2
Calls that Organizer makes to Clapshot server
rpc handshake (, )
organizer.proto:33message
organizer.proto:124optional version = 1
string name = 2
Make sure this is (globally) unique, e.g. "com.example.myorganizer", to avoid conflicts
string description = 3
Human-readable description of the organizer plugin
repeated hard_dependencies = 4
List of any other modules that must be present for this module to work
Multiple calls will add/replace actions
message
organizer.proto:305string sid = 1
map<string, > actions = 2
e.g. "rename" -> {label: "Rename", icon: "edit"}
rpc client_show_page (, )
organizer.proto:36message
organizer.proto:294optional msg = 1
oneof recipient
string sid = 100
send to client with this session ID
string user_temp = 101
send to all session with this username
string user_persist = 102
send to all sessions with this username, and store in DB
string media_file_id = 103
send to all clients watching this media file
string collab_session = 104
send to all clients in this collaboration session
message
organizer.proto:311Tell client of session `sid` to open media file `id` in the player
string sid = 1
string id = 2
rpc client_set_cookies (, )
organizer.proto:39message
organizer.proto:316string sid = 1
map<string, string> cookies = 2
optional expire_time = 3
rpc delete_media_file (, )
organizer.proto:41Delete (trash) media file cleanly from both database and filesystem
message
organizer.proto:322string id = 1
rpc DbGetMediaFiles (, )
organizer.proto:44Database access (note: these may each happen in a separate DB connection / transaction)
message
database.proto:6optional paging = 1
oneof filter
all = 10
All media files in the database. Make sure to set paging.
ids = 11
List of media file ids
string user_id = 12
Owner of the media file
message
database.proto:83repeated items = 1
optional paging = 2
Paging info for the result. Some queries may not do paging even if requested, so check for presence.
rpc DbGetComments (, )
organizer.proto:45message
database.proto:15optional paging = 1
oneof filter
all = 10
All comments in the database. Make sure to set paging.
ids = 11
List of comment ids
string user_id = 12
User who posted the comment
string media_file_id = 13
MediaFile the comments are attached to
message
database.proto:93repeated items = 1
optional paging = 2
rpc DbGetUserMessages (, )
organizer.proto:46message
database.proto:25optional paging = 1
oneof filter
all = 10
All user messages in the database. Make sure to set paging.
ids = 11
List of message ids
string user_id = 12
Message recipient
string media_file_id = 13
MediaFile the message refers to
string comment_id = 14
Comment the message refers to
message
database.proto:98repeated items = 1
optional paging = 2
rpc DbUpsert (, )
organizer.proto:47message
database.proto:41Add or replace objects in the database. If an ID is not specified, a new object will be created, otherwise the existing object will be replaced.
repeated media_files = 1
repeated subtitles = 2
repeated comments = 3
repeated user_messages = 4
message
database.proto:48repeated media_files = 1
These will have IDs, creation timestamps, etc. filled in.
repeated subtitles = 2
repeated comments = 3
repeated user_messages = 4
rpc DbDelete (, )
organizer.proto:48message
database.proto:56repeated string media_file_ids = 1
repeated string subtitle_ids = 2
repeated string comment_ids = 3
repeated string user_message_ids = 4
message
database.proto:63uint32 media_files_deleted = 1
uint32 subtitles_deleted = 2
uint32 comments_deleted = 3
uint32 user_messages_deleted = 4
message
organizer.proto:174(message has no fields)
message
organizer.proto:245Used in:
optional comment = 1
CommentOp.Op op = 2
Used in:
EDIT = 0
DELETE = 1
message
organizer.proto:233Used in:
optional media_file = 1
MediaFileOp.Op op = 2
Used in:
VIEW = 0
RENAME = 1
DELETE = 2
COMMENT = 3
EDIT = 4
message
organizer.proto:222Used in:
OtherOp.Op op = 1
optional string subject = 2
Used in:
LOGIN = 0
VIEW_HOME = 1
UPLOAD_MEDIA_FILE = 2
JOIN_COLLAB_SESSION = 10
message
organizer.proto:287Used as request type in: OrganizerOutbound.client_show_page
Used as response type in: OrganizerInbound.navigate_page
string sid = 1
repeated page_items = 2
optional string page_id = 3
Arbitrary string to identify the page. When this changes, the client will consider it a new page in browser history
optional string page_title = 4
shown in browser tab
message
organizer.proto:83Used in: , ,
Database.DatabaseType type = 1
string endpoint = 2
Used in:
SQLITE = 0
message
database.proto:72Used in: , , , , , ,
uint32 page_num = 1
Page number (0 = first page)
uint32 page_size = 2
Number of items per page
message
database.proto:88repeated items = 1
optional paging = 2
message
database.proto:77Used in: , ,
repeated string ids = 1
message
organizer.proto:145Used in:
string uuid = 1
Unique identifier for this migration
string version = 2
Schema version this migration will result in. (must be sortable (e.g. "1.2.3", "2024-01-02_b" etc)
repeated dependencies = 3
Note: remember to include the plugin itself in the list, if needed
string description = 4
Human-readable description of the migration, for logging
message
organizer.proto:151Used in:
string name = 1
Plugin/module whose schema version to check
optional string min_ver = 2
"Name"'s schema version must be at least this for this migration to be applicable. (not set = any)
optional string max_ver = 3
--||-- at most --||--
message
organizer.proto:132Used in:
string name = 1
e.g. "com.example.someotherorganizer", or "clapshot.server" for the core server
optional min_ver = 2
message
organizer.proto:137Used in: , ,
uint64 major = 1
uint64 minor = 2
uint64 patch = 3
message
organizer.proto:102Used in:
oneof endpoint
unix = 1
tcp = 2
message
organizer.proto:106Used in:
string host = 1
uint32 port = 2
message
organizer.proto:103Used in:
string path = 1
message
organizer.proto:93Used in:
oneof storage
local_fs = 1
message
organizer.proto:94Used in:
string base_dir = 1
message
organizer.proto:179Used in: , , , , ,
string sid = 1
optional user = 2
bool is_admin = 3
map<string, string> cookies = 4