RSX Code Reference
    Preparing search index...
    • rsx
    • PackageResourceMetaData

    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.

    Index
    constructor
    creationUserID dependencies isCreationUserInternal isExternal isOffline isPrimary isProjectOrUserSpecific isReadOnly isResident isStreaming isSubresource ownerUserID path protectedUserID sequentialVersion streamingResourceUUIDs subresourceParent uuid version
    • get creationUserID(): UUID

      The creator of the file.

      Returns UUID

    • get isCreationUserInternal(): boolean

      Determines if the resource was created by an internal system.

      Returns boolean

    • get isExternal(): boolean

      Determines if the resource is external.

      Returns boolean

    • get isOffline(): boolean

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

      Returns boolean

    • get isPrimary(): boolean

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

      Returns boolean

    • get isProjectOrUserSpecific(): boolean

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

      Returns boolean

    • get isReadOnly(): boolean

      Determines if the resource is readonly.

      Returns boolean

    • get isResident(): boolean

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

      Returns boolean

    • get isStreaming(): boolean

      Determines if the resource is a streaming.

      Returns boolean

    • get isSubresource(): boolean

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

      Returns boolean

    • get ownerUserID(): UUID

      The owner of the file.

      Returns UUID

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

    • get protectedUserID(): UUID

      The user that can currently edit and upload the file.

      Returns UUID

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

    • get sequentialVersion(): number

      Returns number

    • get subresourceParent(): UUID

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

      Returns UUID

    • set subresourceParent(value: UUID): void

      Parameters

      Returns void

    • get uuid(): UUID

      Unique identifier of the resource.

      Returns UUID

    • set uuid(value: UUID): void

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors