palm-pdb
    Preparing search index...

    Class DatabaseAttrs

    Database attribute flags.

    References:

    Hierarchy

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

    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

    • Returns DatabaseAttrs

    Properties

    appInfoDirty: boolean = false

    Set if Application Info block is dirty.

    Optionally supported by an App's conduit.

    backup: boolean = false

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

    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: boolean = false

    This database should not be copied to

    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: 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: 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: boolean = false

    Database not closed properly.

    readOnly: boolean = false

    Read Only database.

    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: boolean = false

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

    resetAfterInstall: boolean = false

    Device requires a reset after this database is installed.

    stream: boolean = false

    This database is used for file stream implementation.

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

    Methods

    • Parameters

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

      Returns void

    • Parameters

      • buffer: Buffer
      • Optionalopts: DeserializeOptions

      Returns number

    • Parameters

      • Optionalopts: SerializeOptions

      Returns number

    • Parameters

      • Optionalopts: SerializeOptions

      Returns Buffer

    • Returns any

    • Type Parameters

      • T extends Serializable

      Parameters

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

      Returns T

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

      Type Parameters

      • SBitmaskT extends SBitmask

      Parameters

      Returns SBitmaskT

    • Returns an SBitmask class that serializes using the provided SerializableWrapper.

      Parameters

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

      Returns {
          from<T extends Serializable>(
              this: new () => T,
              buffer: Buffer,
              opts?: DeserializeOptions,
          ): T;
          of<SBitmaskT extends SBitmask>(
              this: new () => SBitmaskT,
              value: number,
          ): SBitmaskT;
          of(
              wrapperType: new () => SerializableWrapper<number>,
          ): { new (): { wrapperType: new () => SerializableWrapper<number>; value: number; deserialize(buffer: Buffer<ArrayBufferLike>, opts?: DeserializeOptions | undefined): number; serialize(opts?: SerializeOptions | undefined): Buffer<...>; getSerializedLength(opts?: SerializeOptions | undefined): number; toJSON(): any; ass...;
          with<T extends SBitmask>(this: new () => T, props?: Partial<T>): T;
          new (): {
              value: number;
              wrapperType: new () => SerializableWrapper<number>;
              assignJSON(jsonValue: number | { [key: string | symbol]: number }): void;
              deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
              getSerializedLength(opts?: SerializeOptions): number;
              serialize(opts?: SerializeOptions): Buffer;
              toJSON(): any;
          };
      }

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

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

      • from: function
        • from<T extends Serializable>(
              this: new () => T,
              buffer: Buffer,
              opts?: DeserializeOptions,
          ): T

          Type Parameters

          • T extends Serializable

          Parameters

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

          Returns T

      • of: function
        • of<SBitmaskT extends SBitmask>(
              this: new () => SBitmaskT,
              value: number,
          ): SBitmaskT

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

          Type Parameters

          • SBitmaskT extends SBitmask

          Parameters

          Returns SBitmaskT

        • of(
              wrapperType: new () => SerializableWrapper<number>,
          ): { new (): { wrapperType: new () => SerializableWrapper<number>; value: number; deserialize(buffer: Buffer<ArrayBufferLike>, opts?: DeserializeOptions | undefined): number; serialize(opts?: SerializeOptions | undefined): Buffer<...>; getSerializedLength(opts?: SerializeOptions | undefined): number; toJSON(): any; ass...

          Returns an SBitmask class that serializes using the provided SerializableWrapper.

          Parameters

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

          Returns { new (): { wrapperType: new () => SerializableWrapper<number>; value: number; deserialize(buffer: Buffer<ArrayBufferLike>, opts?: DeserializeOptions | undefined): number; serialize(opts?: SerializeOptions | undefined): Buffer<...>; getSerializedLength(opts?: SerializeOptions | undefined): number; toJSON(): any; ass...

      • with: function
        • with<T extends SBitmask>(this: new () => T, props?: Partial<T>): T

          Create a new instance with the provided initial properties.

          Type Parameters

          • T extends SBitmask

          Parameters

          • this: new () => T
          • Optionalprops: Partial<T>

          Returns T

    • Create a new instance with the provided initial properties.

      Type Parameters

      • T extends SBitmask

      Parameters

      • this: new () => T
      • Optionalprops: Partial<T>

      Returns T

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods