package anki.sync

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc SyncMedia (SyncAuth, generic.Empty)

  sync.proto:16

• rpc AbortMediaSync (generic.Empty, generic.Empty)

  sync.proto:17

• rpc MediaSyncStatus (generic.Empty, MediaSyncStatusResponse)

  sync.proto:20

  Can be used by the frontend to detect an active sync. If the sync aborted with an error, the next call to this method will return the error.

  message MediaSyncStatusResponse

  sync.proto:74

  • bool active = 1

  • optional MediaSyncProgress progress = 2

• rpc SyncLogin (SyncLoginRequest, SyncAuth)

  sync.proto:21

  message SyncLoginRequest

  sync.proto:35

  • string username = 1

  • string password = 2

  • optional string endpoint = 3

• rpc SyncStatus (SyncAuth, SyncStatusResponse)

  sync.proto:22

  message SyncStatusResponse

  sync.proto:41

  • SyncStatusResponse.Required required = 1

  • optional string new_endpoint = 4

• rpc SyncCollection (SyncCollectionRequest, SyncCollectionResponse)

  sync.proto:23

  message SyncCollectionRequest

  sync.proto:51

  • optional SyncAuth auth = 1

  • bool sync_media = 2

  message SyncCollectionResponse

  sync.proto:56

  • uint32 host_number = 1

  • string server_message = 2

  • SyncCollectionResponse.ChangesRequired required = 3

  • optional string new_endpoint = 4

  • int32 server_media_usn = 5

• rpc FullUploadOrDownload (FullUploadOrDownloadRequest, generic.Empty)

  sync.proto:24

  message FullUploadOrDownloadRequest

  sync.proto:85

  • optional SyncAuth auth = 1

  • bool upload = 2

  • optional int32 server_usn = 3

    if not provided, media syncing will be skipped

• rpc AbortSync (generic.Empty, generic.Empty)

  sync.proto:25

• rpc SetCustomCertificate (generic.String, generic.Bool)

  sync.proto:26

Syncing methods are only available with a Backend handle.

(no methods)

Used in: collection.Progress, MediaSyncStatusResponse

• string checked = 1

• string added = 2

• string removed = 3

Used as request type in: BackendSyncService.SyncMedia, BackendSyncService.SyncStatus

Used as response type in: BackendSyncService.SyncLogin

Used as field type in: FullUploadOrDownloadRequest, SyncCollectionRequest

• string hkey = 1

• optional string endpoint = 2

• optional uint32 io_timeout_secs = 3

Used in: SyncCollectionResponse

• NO_CHANGES = 0

• NORMAL_SYNC = 1

• FULL_SYNC = 2

• FULL_DOWNLOAD = 3

  local collection has no cards; upload not an option

• FULL_UPLOAD = 4

  remote collection has no cards; download not an option

Used in: SyncStatusResponse

• NO_CHANGES = 0

• NORMAL_SYNC = 1

• FULL_SYNC = 2