Class CloudLibraryWatchdog

constructor

• new CloudLibraryWatchdog(): CloudLibraryWatchdog

  Returns CloudLibraryWatchdog

StaticcatalogJson

• get catalogJson(): JsonObject

  Gets the current catalog json from the most-recent sync operation.

  Returns JsonObject

  Catalog JSON.

  Note

  Thread-safe.

  Note

  This operation should only be used for debug purposes as a large JSON object must be copied.

StaticcatalogPostData

• get catalogPostData(): JsonObject

  Sets the catalog post data that is sent to the server when requesting the catalog.

  Returns JsonObject

• set catalogPostData(value: JsonObject): void

  Parameters

  • value: JsonObject

  Returns void

StaticcatalogProjectMetadata

• get catalogProjectMetadata(): Immutable<CatalogProjectMetadata>

  Gets the current catalog metadata from the most-recent sync operation.

  Returns Immutable<CatalogProjectMetadata>

  Catalog Metadata

  Note

  Thread-safe.

StaticcatalogProjectReferences

• get catalogProjectReferences(): Iterable<CatalogProjectReference>

  Gets the current catalog json from the most-recent sync operation.

  Returns Iterable<CatalogProjectReference>

  Catalog Project References.

  Note

  Thread-safe.

StaticcheckoutProgress

• get checkoutProgress(): number

  Returns the progress in percent for the number of packages that have been downloaded.

  Returns number

  Note

  The value is calculated based on the number of bytes on disk, vs. the number of bytes pending.

StaticisAvailable

• get isAvailable(): boolean

  Determines if a mesh processor is available.

  Returns boolean

StaticisDeltaApplyEnabled

• get isDeltaApplyEnabled(): boolean

  True if we're allowing new deltas to be ingested.

  Returns boolean

• set isDeltaApplyEnabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

StaticisIdle

• get isIdle(): boolean

  Determines if the watchdog is idle. That means, not downloading, uploading or fetching the project catalog.

  Returns boolean

StaticisPendingConflictsResolution

• get isPendingConflictsResolution(): boolean

  Checks if there are any conflicted files pending resolution.

  Returns boolean

StaticisReadOnly

• get isReadOnly(): boolean

  Determines if the readonly mode is enabled. Packages can be downloaded, but not uploaded or deleted.

  Returns boolean

StaticisRuntimeStreaming

• get isRuntimeStreaming(): boolean

  Determines if the runtime streaming mode is enabled. Packages can be downloaded from a deployment location.

  Returns boolean

StaticisStorageFull

• get isStorageFull(): boolean

  Determines if the cloud storage is full. When true, uploads are blocked until storage becomes available.

  Returns boolean

StaticdownloadFile

• downloadFile(
      uuid: UUID,
      forceDownload: boolean,
      prioritize: boolean,
  ): AsyncOp<CloudOperationResult>

  Starts download of the resource from the server.

  Parameters

  • uuid: UUID

    UUID of the resource to download.

  • forceDownload: boolean

    Forces the download, even when it's not required.

  • prioritize: boolean

    Prioritizes the download by moving it to the top of the queue.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

StaticdownloadFileImmediate

• downloadFileImmediate(url: URL): AsyncOp<CloudDownloadOperationResult>

  Downloads the resource at the specified url.

  Parameters

  • url: URL

    The URL of the file to download.

  Returns AsyncOp<CloudDownloadOperationResult>

  Object that can be used for tracking the status of the operation, and will contain the download result when the operation completes.

StaticgetCatalogEntry

• getCatalogEntry(uuid: UUID): CatalogEntry

  Gets the catalog entry for the resource with provided UUID from the catalog. Uses information from the last performed Sync() operation.

  Parameters

  • uuid: UUID

    The UUID

  Returns CatalogEntry

  The optional CatalogEntry.

  Note

  Thread-safe.

StaticgetOutOfBandData

• getOutOfBandData(
      projectUUID: UUID,
      fileUUID: UUID,
  ): UncertainAsyncOp<JsonObject, string>

  Retrieves all current out-of-band data from the server, for the provided project file.

  Parameters

  • projectUUID: UUID

    The UUID of the project the file belongs to.

  • fileUUID: UUID

    The UUID of the file to retrieve out-of-band data for.

  Returns UncertainAsyncOp<JsonObject, string>

  An AsyncOp that will be resolved once the request is done or failed.

StaticgetResourceUUIDsForProjectReference

• getResourceUUIDsForProjectReference(projectReferenceUUID: UUID): UUID[]

  Gets the external resource UUIDs for the projectReferenceUUID from the most-recent sync operation.

  Parameters

  • projectReferenceUUID: UUID

  Returns UUID[]

  Resource UUIDs part of the external project.

  Note

  Thread-safe.

StaticgetVersionHistory

• getVersionHistory(
      resourceUUID: UUID,
      version: UUID,
      isRequestingSignedURL?: boolean,
  ): AsyncOp<CloudVersionHistoryResult>

  Returns version history information for a single version of particular resource.

  Parameters

  • resourceUUID: UUID

    UUID of the resource to retrieve the version for.

  • version: UUID

    Particular version UUID we're looking information for.

  • OptionalisRequestingSignedURL: boolean

    If true, download URL(s) for the resource will be provided in the return value.

  Returns AsyncOp<CloudVersionHistoryResult>

  Object that can be used for tracking the status of the operation, and will contain the version history result when the operation completes.

StaticisContainedInCatalog

• isContainedInCatalog(uuid: UUID): boolean

  Checks is the resource with provided UUID in the catalog. Uses information from the last performed Sync() operation.

  Parameters

  • uuid: UUID

    The UUID

  Returns boolean

  True if the entry is contained in the catalog.

  Note

  Thread-safe.

StaticlockFile

• lockFile(
      uuid: UUID,
      version: Immutable<CloudLibraryVersion>,
  ): AsyncOp<CloudOperationResult>

  Attempts to acquire a lock on a resource.

  Parameters

  • uuid: UUID

    UUID of the resource to lock.

  • version: Immutable<CloudLibraryVersion>

    Version of the resource to acquire the lock on.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation. Value field will be set to the lock ID, if the operation succeeded.

Staticreset

• reset(uuid: UUID): AsyncOp<CloudOperationResult>

  Resets the resource to its version from the server, discarding local changes.

  Parameters

  • uuid: UUID

    UUID of the resource to reset.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

StaticrevertResourceToVersion

• revertResourceToVersion(
      resourceUUID: UUID,
      version: CloudResourceVersionHistory,
      deltaURLs: URL[],
  ): AsyncOp<CloudOperationResult>

  Reverts a resource to the specified version by downloading the version and marking it as current. If the resource has local changes, they will be lost. If the resource has streaming data, it will be downloaded as well.

  Parameters

  • resourceUUID: UUID

    UUID of the resource to revert.

  • version: CloudResourceVersionHistory

    Version to revert to.

  • deltaURLs: URL[]

    Optionally, URLs of deltas to download for the resource, if any. The deltaURLs must be in sequential ordered low to high sequential.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

StaticsetOutOfBandData

• setOutOfBandData(
      projectUUID: UUID,
      fileUUID: UUID,
      data: JsonObject,
  ): UncertainAsyncOp<JsonObject, string>

  Updates the out-of-band data for the current user on the server, for the provided project file.

  Parameters

  • projectUUID: UUID

    The UUID of the project the file belongs to.

  • fileUUID: UUID

    The UUID of the file to update out-of-band data for.

  • data: JsonObject

    The new out-of-band data to be updated. Missing entries will be kept, however entries with a null value will be removed completely.

  Returns UncertainAsyncOp<JsonObject, string>

  An AsyncOp that will be resolved once the request is done or failed.

StaticsetShouldSync

• setShouldSync(isSyncing: boolean): void

  If disabled, the watchdog will not perform any operations until re-enabled.

  Parameters

  • isSyncing: boolean

  Returns void

Staticsync

• sync(isSyncingAllData?: boolean): AsyncOp<CloudOperationResult>

  Retrieves the latest catalog from the cloud server and checks for local changes. Queues upload, download and delete operations accordingly.

  Parameters

  • OptionalisSyncingAllData: boolean

    If true, all data will be downloaded, including streaming data which would normally be downloaded on-demand.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

StaticsyncScene

• syncScene(scene: SceneInstance): AsyncOp<CloudOperationResult>

  Checks if the provided scene has any local changes, and if so generates a delta and uploads it to the server. If the server has changes the local changes will be rolled back and re-applied on the server changes, without requiring user intervention.

  Parameters

  • scene: SceneInstance

    Scene to check for changes.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

StatictryPopAction

• tryPopAction(): WatchdogAction

  Pops an action from the watchdog action queue, if one exists. Returns null otherwise. Actions can be used to track watchdog progress by an external system.

  Returns WatchdogAction

StaticunlockFile

• unlockFile(uuid: UUID, lockId: string): AsyncOp<CloudOperationResult>

  Unlocks a previously locked resource.

  Parameters

  • uuid: UUID

    UUID of the resource to unlock.

  • lockId: string

    Lock ID of the previously acquired lock.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

StaticupdateConflictResolutionForResource

• updateConflictResolutionForResource(
      resourceUUID: UUID,
      type: EnumValue<ConflictResolutionType>,
  ): boolean

  Updates the conflict resolution for the resource with the specified uuid to the resolution type.

  Parameters

  • resourceUUID: UUID
  • type: EnumValue<ConflictResolutionType>

  Returns boolean

StaticuploadFile

• uploadFile(uuid: UUID, lockId: string): AsyncOp<CloudOperationResult>

  Starts upload of a local resource. Resource must have been previously locked via LockFile().

  Parameters

  • uuid: UUID

    UUID of the resource to upload. Current version from the project library will be uploaded.

  • lockId: string

    Lock ID of the acquired lock on the resource.

  Returns AsyncOp<CloudOperationResult>

  Object that can be used for tracking the status of the operation.

Static ReadonlyonDetermineCodeResourceUploadBlock

Static ReadonlyonStorageFullChanged

Static ReadonlyonSyncInformationProcessed

Static ReadonlyonProjectReferenceAdded

Static ReadonlyonProjectReferenceRemoved