Class LibraryOperationSettings

Additional settings that may be provided when performing operations in the project library.

Index

Constructors

Properties

_baseVersion _cloneResource _flags _newVersion

Accessors

baseVersion cloneResource flags newVersion

Methods

assign clone isEqual isEqual

Constructors

constructor

new LibraryOperationSettings(
    newVersion?: UUID,
    baseVersion?: Immutable<CloudLibraryVersion>,
    cloneResource?: boolean,
    flags?: EnumValue<ProjectLibraryEntryMetaDataFlags>,
): LibraryOperationSettings
Parameters
- OptionalnewVersion: UUID
- OptionalbaseVersion: Immutable<CloudLibraryVersion>
- OptionalcloneResource: boolean
- Optionalflags: EnumValue<ProjectLibraryEntryMetaDataFlags>
Returns LibraryOperationSettings

Properties

`Protected`_baseVersion

_baseVersion: CloudLibraryVersion

`Protected`_cloneResource

_cloneResource: boolean

`Protected`_flags

_flags: EnumValue<ProjectLibraryEntryMetaDataFlags>

`Protected`_newVersion

_newVersion: UUID

Accessors

baseVersion

get baseVersion(): CloudLibraryVersion

Base version of the resource that is currently in the local library, at the time we're requesting the new version.

Returns CloudLibraryVersion
set baseVersion(value: Immutable<CloudLibraryVersion>): void
Parameters
- value: Immutable<CloudLibraryVersion>
Returns void

cloneResource

get cloneResource(): boolean

True if the source resource should be cloned before sent to the project library worker. This must be true if you plan on accessing the resource while the project library is performing operations, to ensure thread safety.

Returns boolean
set cloneResource(value: boolean): void
Parameters
- value: boolean
Returns void

flags

get flags(): EnumValue<ProjectLibraryEntryMetaDataFlags>

Returns EnumValue<ProjectLibraryEntryMetaDataFlags>
set flags(value: EnumValue<ProjectLibraryEntryMetaDataFlags>): void
Parameters
- value: EnumValue<ProjectLibraryEntryMetaDataFlags>
Returns void

newVersion

get newVersion(): UUID

Explicit new version to assign to the resource. Sequential version will be incremented from the base version. Only relevant for save/create operations. BaseVersion must be provided as well.

Returns UUID
set newVersion(value: UUID): void
Parameters
- value: UUID
Returns void

Methods

assign

assign(other: Immutable<LibraryOperationSettings>): LibraryOperationSettings
Copies all properties defined by the prototype of LibraryOperationSettings from other to this instance.
Parameters
- other: Immutable<LibraryOperationSettings>
Returns LibraryOperationSettings

clone

clone(): LibraryOperationSettings

Clones this instance and returns a new LibraryOperationSettings with identical values.

Returns LibraryOperationSettings

isEqual

isEqual(
this: Immutable<LibraryOperationSettings>,
other: Immutable<LibraryOperationSettings>,
): boolean
Determines if this LibraryOperationSettings instance is equal to the other instance.
Parameters
- this: Immutable<LibraryOperationSettings>
- other: Immutable<LibraryOperationSettings>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<LibraryOperationSettings>,
rhs: Immutable<LibraryOperationSettings>,
): boolean
Determines if both LibraryOperationSettings instances are equal.
Parameters
- lhs: Immutable<LibraryOperationSettings>
- rhs: Immutable<LibraryOperationSettings>
Returns boolean