# IWorkArchiveRecord

One payload record preserved from an IWA object stream.

Class 

`OfficeIMO.IWork`

**Namespace**

`OfficeIMO.IWork`

**Assembly**

`OfficeIMO.IWork`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[IWorkArchiveRecord.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L39)

**Modifiers**

sealed

One payload record preserved from an IWA object stream.

## Inheritance

- object
- IWorkArchiveRecord

## Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 2

- Property [IWorkConversionReport.PreservedRecords](/api/iwork/officeimo-iwork-iworkconversionreport/#property-preservedrecords)
- Property [IWorkSourceDocument.Records](/api/iwork/officeimo-iwork-iworksourcedocument/#property-records)

Filter members 

Show inherited

## Methods

`public byte[] GetPayload()` [#](#method-getpayload)

[IWorkArchiveRecord.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L39)

Returns a defensive copy of the raw protobuf payload.

Returns

`byte[]`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public ulong Identifier { get; }` [#](#property-identifier)

[IWorkArchiveRecord.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L21)

Gets the object identifier declared by ArchiveInfo.

`public uint MessageType { get; }` [#](#property-messagetype)

[IWorkArchiveRecord.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L23)

Gets the application-specific registry message type.

`public IReadOnlyList<uint> Versions { get; }` [#](#property-versions)

[IWorkArchiveRecord.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L25)

Gets the version vector declared by MessageInfo.

`public IReadOnlyList<ulong> ObjectReferences { get; }` [#](#property-objectreferences)

[IWorkArchiveRecord.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L27)

Gets object identifiers referenced by MessageInfo.

`public IReadOnlyList<ulong> DataReferences { get; }` [#](#property-datareferences)

[IWorkArchiveRecord.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L29)

Gets data identifiers referenced by MessageInfo.

`public string EntryPath { get; }` [#](#property-entrypath)

[IWorkArchiveRecord.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L31)

Gets the IWA package entry containing this record.

`public int PayloadIndex { get; }` [#](#property-payloadindex)

[IWorkArchiveRecord.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L33)

Gets the zero-based payload position within the ArchiveInfo group.

`public bool IsPrimary { get; }` [#](#property-isprimary)

[IWorkArchiveRecord.cs:35](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L35)

Gets whether this is the primary object payload in its ArchiveInfo group.

`public int PayloadLength { get; }` [#](#property-payloadlength)

[IWorkArchiveRecord.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkArchiveRecord.cs#L37)

Gets the raw payload length.

<!-- PowerForge markdown artifact sha256:A1FE0E9BC2426E1C46E8F6944F4244CF3D4A0016B5D8AA295F1DA60E85F1FBB7 -->
