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 | symbol]: number }): void;
    deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
    getSerializedLength(opts?: SerializeOptions): number;
    serialize(opts?: SerializeOptions): Buffer;
    toJSON(): any;
}
- DlpRecordAttrs

Index

Constructors

constructor

new DlpRecordAttrs(): DlpRecordAttrs
Returns DlpRecordAttrs
Inherited from SBitmask.of(SUInt8).constructor
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:25

Properties

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: number | { [key: string | symbol]: number }): void
Parameters
- jsonValue: number | { [key: string | symbol]: number }
Returns void
Inherited from SBitmask.of(SUInt8).assignJSON
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:32

deserialize

deserialize(buffer: Buffer, opts?: DeserializeOptions): number
Parameters
- buffer: Buffer
- Optionalopts: DeserializeOptions
Returns number
Inherited from SBitmask.of(SUInt8).deserialize
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:28

getSerializedLength

getSerializedLength(opts?: SerializeOptions): number
Parameters
- Optionalopts: SerializeOptions
Returns number
Inherited from SBitmask.of(SUInt8).getSerializedLength
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:30

serialize

serialize(opts?: SerializeOptions): Buffer
Parameters
- Optionalopts: SerializeOptions
Returns Buffer
Inherited from SBitmask.of(SUInt8).serialize
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:29

toJSON

toJSON(): any
Returns any
Inherited from SBitmask.of(SUInt8).toJSON
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:31

`Static`from

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
Inherited from SBitmask.of(SUInt8).from
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:43

`Static`fromRecordAttrs

fromRecordAttrs(
pdbAttrs: RecordAttrs,
): { attributes: DlpRecordAttrs; category: number }
Convert RecordAttrs to DlpRecordAttrs and category for use in DLP protocol.
Parameters
- pdbAttrs: RecordAttrs
Returns { attributes: DlpRecordAttrs; category: number }
- Defined in src/protocols/dlp-commands.ts:1309

`Static`of

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
- this: new () => SBitmaskT
- value: number
Returns SBitmaskT
Inherited from SBitmask.of(SUInt8).of
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:37
of(
    wrapperType: new () => SerializableWrapper<number>,
): {
    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;
    };
}
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
    Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:43
- 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
    this: new () => SBitmaskT
    value: number
    Returns SBitmaskT
    Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:37
  - 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...
    Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:40
- 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
    Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:42
Inherited from SBitmask.of(SUInt8).of
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:40

`Static`toRecordAttrs

toRecordAttrs(dlpAttrs: DlpRecordAttrs, category: number): RecordAttrs
Convert DlpRecordAttrs and category to RecordAttrs for use in PDB files.
Parameters
- dlpAttrs: DlpRecordAttrs
- category: number
Returns RecordAttrs
- Defined in src/protocols/dlp-commands.ts:1282

`Static`with

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
Inherited from SBitmask.of(SUInt8).with
- Defined in node_modules/serio/dist/serializable-bitmasks.d.ts:42

Class DlpRecordAttrs

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DlpRecordAttrs

Properties

archive

busy

delete

dirty

secret

value

wrapperType

Methods

assignJSON

Parameters

Returns void

deserialize

Parameters

Returns number

getSerializedLength

Parameters

Returns number

serialize

Parameters

Returns Buffer

toJSON

Returns any

Staticfrom

Type Parameters

Parameters

Returns T

StaticfromRecordAttrs

Parameters

Returns { attributes: DlpRecordAttrs; category: number }

Staticof

Type Parameters

Parameters

Returns SBitmaskT

Parameters

from: function

Type Parameters

Parameters

Returns T

of: function

Type Parameters

Parameters

Returns SBitmaskT

Parameters

with: function

Type Parameters

Parameters

Returns T

StatictoRecordAttrs

Parameters

Returns RecordAttrs

Staticwith

Type Parameters

Parameters

Returns T

Settings

On This Page

`Static`from

`Static`fromRecordAttrs

`Static`of

`Static`toRecordAttrs

`Static`with