Class DlpRecordAttrs

Record attribute flags in the DLP protocol.

In the DLP protocol, we use one byte to store record attribute flags and another byte to store the record category. However, in PDB files, we use a single byte is used to store both attribute flags and the record category.

See RecordAttrs for more context.

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;
    }
    • DlpRecordAttrs

Constructors

constructor

Properties

archive busy delete dirty secret value wrapperType

Methods

assignJSON deserialize getSerializedLength serialize toJSON from fromRecordAttrs of toRecordAttrs with

Constructors

constructor

  • new DlpRecordAttrs(): DlpRecordAttrs

  • Returns DlpRecordAttrs

Properties

archive

archive: boolean = false

Record is archived.

busy

busy: boolean = false

Record currently in use.

This bit may also indicate the record has been deleted -- see comments in https://github.com/dwery/coldsync/blob/master/include/pdb.h .

delete

delete: boolean = false

Record has been deleted.

dirty

dirty: boolean = false

Record has been modified.

secret

secret: boolean = false

"Secret" record - password protected.

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

StaticfromRecordAttrs

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

StatictoRecordAttrs

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