Class DatabaseAttrs

Database attribute flags.

References:

Hierarchy

  • {
        value: number;
        wrapperType: (new () => SerializableWrapper<number>);
        assignJSON(jsonValue: number | {
            [key: string]: number;
            [key: symbol]: number;
        }): void;
        deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
        getSerializedLength(opts?: SerializeOptions): number;
        serialize(opts?: SerializeOptions): Buffer;
        toJSON(): any;
    }
    • DatabaseAttrs

Constructors

constructor

Properties

appInfoDirty backup bundle copyPrevention hidden launchableData okToInstallNewer open readOnly recyclable resDB resetAfterInstall stream value wrapperType

Methods

assignJSON deserialize getSerializedLength serialize toJSON from of with

Constructors

constructor

  • new DatabaseAttrs(): DatabaseAttrs

  • Returns DatabaseAttrs

Properties

appInfoDirty

appInfoDirty: boolean = false

Set if Application Info block is dirty.

Optionally supported by an App's conduit.

backup

backup: boolean = false

Set if database should be backed up to PC if no app-specific synchronization conduit has been supplied.

bundle

bundle: boolean = false

This database (resource or record) is associated with the application with the same creator. It will be beamed and copied along with the application.

copyPrevention

copyPrevention: boolean = false

This database should not be copied to

hidden

hidden: boolean = false

This database should generally be hidden from view.

Used to hide some apps from the main view of the launcher for example. For data (non-resource) databases, this hides the record count within the launcher info screen.

launchableData

launchableData: boolean = false

This data database (not applicable for executables) can be "launched" by passing its name to it's owner app ('appl' database with same creator) using the sysAppLaunchCmdOpenNamedDB action code.

okToInstallNewer

okToInstallNewer: boolean = false

This tells the backup conduit that it's OK for it to install a newer version of this database with a different name if the current database is open. This mechanism is used to update the Graffiti Shortcuts database, for example.

open

open: boolean = false

Database not closed properly.

readOnly

readOnly: boolean = false

Read Only database.

recyclable

recyclable: boolean = false

This database (resource or record) is recyclable: it will be deleted Real Soon Now, generally the next time the database is closed.

resDB

resDB: boolean = false

Whether this is a resource database (i.e. PRC).

resetAfterInstall

resetAfterInstall: boolean = false

Device requires a reset after this database is installed.

stream

stream: boolean = false

This database is used for file stream implementation.

value

value: number

wrapperType

wrapperType: (new () => SerializableWrapper<number>)

Methods

assignJSON

  • assignJSON(jsonValue): void

  • Parameters

    • jsonValue: number | {
          [key: string]: number;
          [key: symbol]: number;
      }

    Returns void

deserialize

  • deserialize(buffer, opts?): number

  • Parameters

    • buffer: Buffer
    • Optionalopts: DeserializeOptions

    Returns number

getSerializedLength

  • getSerializedLength(opts?): number

  • Parameters

    • Optionalopts: SerializeOptions

    Returns number

serialize

  • serialize(opts?): Buffer

  • Parameters

    • Optionalopts: SerializeOptions

    Returns Buffer

toJSON

  • toJSON(): any

  • Returns any

Staticfrom

  • from<T_1>(this, buffer, opts?): T_1

  • Type Parameters

    • T_1 extends Serializable

    Parameters

    • this: (new () => T_1)
    • buffer: Buffer
    • Optionalopts: DeserializeOptions

    Returns T_1

Staticof

  • of<SBitmaskT>(this, value): SBitmaskT

  • Create a new instance of this wrapper class from a raw value.

    Type Parameters

    • SBitmaskT extends SBitmask

    Parameters

    Returns SBitmaskT

  • of(wrapperType): any

  • Create a new instance of this wrapper class from a raw value.

    Parameters

    • wrapperType: (new () => SerializableWrapper<number>)
        • new (): SerializableWrapper<number>

        • Returns SerializableWrapper<number>

    Returns any

Staticwith

  • with<T>(this, props?): T

  • Create a new instance with the provided initial properties.

    Type Parameters

    • T extends SBitmask

    Parameters

    • this: (new () => T)
        • new (): T

        • Returns T

    • Optionalprops: Partial<T>

    Returns T

Settings

Member Visibility

On This Page

Constructors
Properties
Methods