Home > git-documentdb > Collection > onSyncEvent
Collection.onSyncEvent() method#
Add SyncEvent handler
Signature:Parameters#
| Parameter | Type | Description |
|---|---|---|
| sync | SyncInterface | |
| event | SyncEvent | |
| callback | SyncCallback |
- GitDocumentDB
- Collection
- Sync
- TaskQueue
- RemoteRepository
- Validator
- Const
- DATABASE_CREATOR variable
- DATABASE_VERSION variable
- DEFAULT_COMBINE_DB_STRATEGY variable
- DEFAULT_CONFLICT_RESOLUTION_STRATEGY variable
- DEFAULT_LOCAL_DIR variable
- DEFAULT_LOG_LEVEL variable
- DEFAULT_SYNC_INTERVAL variable
- DUPLICATED_FILE_POSTFIX variable
- FILE_CREATE_TIMEOUT variable
- FILE_REMOVE_TIMEOUT variable
- FIRST_COMMIT_MESSAGE variable
- GIT_DOCUMENTDB_INFO_ID variable
- GIT_DOCUMENTDB_METADATA_DIR variable
- JSON_POSTFIX variable
- FRONT_MATTER_POSTFIX variable
- MAX_FILE_PATH_LENGTH variable
- MINIMUM_SYNC_INTERVAL variable
- NETWORK_RETRY_INTERVAL variable
- NETWORK_RETRY variable
- NETWORK_TIMEOUT variable
- PUT_APP_INFO_MESSAGE variable
- SET_DATABASE_ID_MESSAGE variable
- SHORT_SHA_LENGTH variable
- Type
- AcceptedConflict type
- BinaryDocMetadata type
- ChangedFile type
- ChangedFileDelete type
- ChangedFileInsert type
- ChangedFileUpdate type
- CollectionInterface interface
- CollectionOptions type
- CollectionPath type
- CombineDbStrategies type
- ConflictResolutionStrategies type
- ConflictResolutionStrategyLabels type
- ConnectionSettings type
- ConnectionSettingsGitHub type
- ConnectionSettingsNone type
- ConnectionSettingsSSH type
- DatabaseCloseOption type
- DatabaseInfo type
- DatabaseOpenResult type
- DatabaseOptions type
- DeleteOptions type
- DeleteResult type
- DeleteResultBinary type
- DeleteResultJsonDoc type
- DeleteResultText type
- Doc type
- DocMetadata type
- DocType type
- DuplicatedFile type
- FatBinaryDoc type
- FatDoc type
- FatJsonDoc type
- FatTextDoc type
- FindOptions type
- GetOptions type
- HistoryFilter type
- HistoryOptions type
- ICollection type
- JsonDiffPatchOptions type
- JsonDoc type
- JsonDocMetadata type
- NormalizedCommit type
- OpenOptions type
- PluginTypes type
- PutOptions type
- PutResult type
- PutResultBinary type
- PutResultJsonDoc type
- PutResultText type
- RemoteOptions type
- Schema type
- SerializeFormatLabel type
- SyncCallback type
- SyncChangeCallback type
- SyncCombineDatabaseCallback type
- SyncCompleteCallback type
- SyncDirection type
- SyncErrorCallback type
- SyncEvent type
- SyncEventInterface interface
- SyncInterface interface
- SyncLocalChangeCallback type
- SyncPauseCallback type
- SyncRemoteChangeCallback type
- SyncResult type
- SyncResultCancel type
- SyncResultCombineDatabase type
- SyncResultFastForwardMerge type
- SyncResultMergeAndPush type
- SyncResultMergeAndPushError type
- SyncResultNop type
- SyncResultPush type
- SyncResultResolveConflictsAndPush type
- SyncResultResolveConflictsAndPushError type
- SyncResumeCallback type
- SyncStartCallback type
- TaskLabel type
- TaskMetadata type
- TaskStatistics type
- TextDocMetadata type
- WriteOperation type
- Error
- Err namespace
- BaseError
- AuthenticationTypeNotAllowCreateRepositoryError
- CannotConnectRemoteRepositoryError
- CannotCreateDirectoryError
- CannotCreateRemoteRepositoryError
- CannotCreateRepositoryError
- CannotDeleteDataError
- CannotOpenRepositoryError
- CannotWriteDataError
- CombineDatabaseError
- ConsecutiveSyncSkippedError
- DatabaseCloseTimeoutError
- DatabaseClosingError
- DocumentNotFoundError
- FileRemoveTimeoutError
- GitMergeBranchError
- HttpProtocolRequiredError
- IntervalTooSmallError
- InvalidCollectionPathCharacterError
- InvalidCollectionPathLengthError
- InvalidConflictResolutionStrategyError
- InvalidConflictStateError
- InvalidDbNameCharacterError
- InvalidDocTypeError
- InvalidIdCharacterError
- InvalidIdLengthError
- InvalidJsonFileExtensionError
- InvalidJsonObjectError
- InvalidLocalDirCharacterError
- InvalidWorkingDirectoryPathLengthError
- NoMergeBaseFoundError
- PersonalAccessTokenForAnotherAccountError
- PushNotAllowedError
- PushWorkerError
- RemoteAlreadyRegisteredError
- RepositoryNotFoundError
- RepositoryNotOpenError
- RequestTimeoutError
- SameIdExistsError
- SocketTimeoutError
- SyncIntervalLessThanOrEqualToRetryIntervalError
- SyncWorkerError
- TaskCancelError
- ThreeWayMergeError
- UndefinedDatabaseNameError
- UndefinedDBError
- UndefinedDocumentIdError
- UndefinedPersonalAccessTokenError
- UndefinedRemoteURLError
- UndefinedSyncError
- Remote Error
- API Reference
- git-documentdb package