Enumeration LibrarySubOperationType

The LibrarySubOperationType enum represents asynchronous package operations that can be queued on the worker thread.

Note

Many library operations executed from higher-level systems will be broken up into sub-operations that are then processed. Thus, the OnEntryModified event will potentially be invoked several times for one operation.

Constructors

`Protected`constructor

new LibrarySubOperationType(do_not_, construct_, this_, type_): LibrarySubOperationType
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns LibrarySubOperationType

Values

`Static` `Readonly`CaseSensitiveRename

CaseSensitiveRename = 13

Performs a case-sensitive rename in an entry that a case insensitive path system wouldn't detect.

`Static` `Readonly`ChangeAffixedResources

ChangeAffixedResources = 17

The affixed resource changed. This is typically fired as a result to another library modification.

`Static` `Readonly`CopyVFS

CopyVFS = 9

Copies a resource or a folder within the source package path at source sub-path, to the destination package path at the destination sub-path. Source and destination package path are allowed to be the same.

`Static` `Readonly`Create

Create = 0

Registers a new resource within the source package at the source sub-path.

`Static` `Readonly`CreateFolderPFS

CreateFolderPFS = 2

Creates a new empty folder in the physical file system at the location of the source package path.

`Static` `Readonly`CreateFolderVFS

CreateFolderVFS = 1

Creates a new empty folder within the source package file system at the source sub-path.

`Static` `Readonly`CreatePackage

CreatePackage = 3

Creates a new empty package at the location of the source package path.

`Static` `Readonly`DeleteFolder

DeleteFolder = 10

Deletes a physical folder at the location of the source package path.

`Static` `Readonly`DeletePackage

DeletePackage = 4

Deletes an existing package at the location of the source package path.

`Static` `Readonly`DeleteVFSEntry

DeleteVFSEntry = 7

Deletes a resource or a folder in the package located at source package path, at the source sub-path.

`Static` `Readonly`GenerateMetaData

GenerateMetaData = 12

Loads an existing resource, generates its meta-data and writes it into the package.

`Static` `Readonly`Import

Import = 11

Adds the contents of a QueuedImport operation into the package at the source package path.

`Static` `Readonly`MovePackage

MovePackage = 5

Moves a package from the source to destination package path.

`Static` `Readonly`MoveVFS

MoveVFS = 8

Moves a resource or a folder within the source package path at source sub-path, to the destination package path at the destination sub-path. Source and destination package path are allowed to be the same.

`Static` `Readonly`Save

Save = 6

Updates the contents of a resource entry in the source package path at the source sub-path.

`Static` `Readonly`UpdateCloudVersion

UpdateCloudVersion = 15

Updates the CloudVersion of the Resource to the specified version.

`Static` `Readonly`UpdateResourceLibraryIcon

UpdateResourceLibraryIcon = 16

Updates the library icon of a Resource.

`Static` `Readonly`UpdateResourceMetaData

UpdateResourceMetaData = 14

Updates the Meta-data of a Resource.

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration LibrarySubOperationType

Note

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns LibrarySubOperationType

Values

Static ReadonlyCaseSensitiveRename

Static ReadonlyChangeAffixedResources

Static ReadonlyCopyVFS

Static ReadonlyCreate

Static ReadonlyCreateFolderPFS

Static ReadonlyCreateFolderVFS

Static ReadonlyCreatePackage

Static ReadonlyDeleteFolder

Static ReadonlyDeletePackage

Static ReadonlyDeleteVFSEntry

Static ReadonlyGenerateMetaData

Static ReadonlyImport

Static ReadonlyMovePackage

Static ReadonlyMoveVFS

Static ReadonlySave

Static ReadonlyUpdateCloudVersion

Static ReadonlyUpdateResourceLibraryIcon

Static ReadonlyUpdateResourceMetaData

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetValues

Type Parameters

Returns EnumValueTyped<T, number>[]

StatichasFlag

Type Parameters

Parameters

Returns boolean

StatichasFlagChanged

Type Parameters

Parameters

Returns boolean

StaticiterateNames

Returns Generator<string, any, any>

StaticiterateValues

Type Parameters

Returns Generator<EnumValueTyped<T, number>, any, any>

StaticremoveFlag

`Protected`constructor

`Static` `Readonly`CaseSensitiveRename

`Static` `Readonly`ChangeAffixedResources

`Static` `Readonly`CopyVFS

`Static` `Readonly`Create

`Static` `Readonly`CreateFolderPFS

`Static` `Readonly`CreateFolderVFS

`Static` `Readonly`CreatePackage

`Static` `Readonly`DeleteFolder

`Static` `Readonly`DeletePackage

`Static` `Readonly`DeleteVFSEntry

`Static` `Readonly`GenerateMetaData

`Static` `Readonly`Import

`Static` `Readonly`MovePackage

`Static` `Readonly`MoveVFS

`Static` `Readonly`Save

`Static` `Readonly`UpdateCloudVersion

`Static` `Readonly`UpdateResourceLibraryIcon

`Static` `Readonly`UpdateResourceMetaData

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags