Class PackageResourceMetaData

Contains information about a resource stored in the package. This information is stored in the header of the package and may be accessed without loading the actual resource data.

Hierarchy

  • FrameworkObject
    • PackageResourceMetaData

Constructors

constructor

Accessors

creationUserID dependencies isCreationUserInternal isExternal isOffline isPrimary isProjectOrUserSpecific isReadOnly isResident isStreaming isSubresource ownerUserID path protectedUserID sequentialVersion streamingResourceUUIDs subresourceParent uuid version

Constructors

Protectedconstructor

Accessors

creationUserID

  • get creationUserID(): UUID

  • The creator of the file.

    Returns UUID

dependencies

isCreationUserInternal

  • get isCreationUserInternal(): boolean

  • Determines if the resource was created by an internal system.

    Returns boolean

isExternal

  • get isExternal(): boolean

  • Determines if the resource is external.

    Returns boolean

isOffline

  • get isOffline(): boolean

  • Determines if the resource is offline and will not be synced.

    Returns boolean

isPrimary

  • get isPrimary(): boolean

  • Determines if the resource is primary. Subresources a resource parent, which can be accessed via # SubresourceParent.

    Returns boolean

isProjectOrUserSpecific

  • get isProjectOrUserSpecific(): boolean

  • Determines if the resource is project specific and should not be synced as external file.

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

  • Determines if the resource is readonly.

    Returns boolean

isResident

  • get isResident(): boolean

  • Determines if the resource is resident and cannot be deleted from the project.

    Returns boolean

isStreaming

  • get isStreaming(): boolean

  • Determines if the resource is a streaming.

    Returns boolean

isSubresource

  • get isSubresource(): boolean

  • Determines if the resource is a subresource. Subresources have a resource parent, which can be accessed via # SubresourceParent.

    Returns boolean

ownerUserID

  • get ownerUserID(): UUID

  • The owner of the file.

    Returns UUID

    Note

    If the owner is set, the file is only visible to the owner and no other user.

path

  • get path(): FilePath

  • Path to the resource within the package.

    Returns FilePath

  • set path(value): void

  • Parameters

    Returns void

protectedUserID

  • get protectedUserID(): UUID

  • The user that can currently edit and upload the file.

    Returns UUID

    Note

    This is enforced on the client, not by the server.

sequentialVersion

  • get sequentialVersion(): number

  • Returns number

streamingResourceUUIDs

subresourceParent

  • get subresourceParent(): UUID

  • Parent of this subresource, or empty if not a subresource.

    Returns UUID

  • set subresourceParent(value): void

  • Parameters

    Returns void

uuid

  • get uuid(): UUID

  • Unique identifier of the resource.

    Returns UUID

  • set uuid(value): void

  • Parameters

    Returns void

version

Settings

Member Visibility

On This Page

Constructors
Accessors