# FileInfo

## Content

# Class: FileInfo

Represents information about a file for a particular platform,
see [FileSpecification.file](FileSpecification#file), [FileSpecification.unicodeFile](FileSpecification#unicodefile),
[FileSpecification.dosFile](FileSpecification#dosfile), [FileSpecification.macFile](FileSpecification#macfile) and
[FileSpecification.unixFile](FileSpecification#unixfile).

## Extends

- [`ObjectBase`](ObjectBase)

## Accessors

### embeddedFileStream

#### Get Signature

```ts
get embeddedFileStream(): EmbeddedFileStream;
```

Gets the [EmbeddedFileStream](EmbeddedFileStream) associated with this file specification.

##### Returns

[`EmbeddedFileStream`](EmbeddedFileStream)

#### Set Signature

```ts
set embeddedFileStream(value): void;
```

Sets the [EmbeddedFileStream](EmbeddedFileStream) associated with this file specification.

##### Parameters

###### value

[`EmbeddedFileStream`](EmbeddedFileStream)

##### Returns

`void`

***

### fileName

#### Get Signature

```ts
get fileName(): string;
```

Gets the file specification string of the form described in the PDF Specification
Section 3.10.1, "File Specification Strings".

##### Returns

`string`

#### Set Signature

```ts
set fileName(value): void;
```

Sets the file specification string of the form described in the PDF Specification
Section 3.10.1, "File Specification Strings".

##### Parameters

###### value

`string`

##### Returns

`void`

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`ObjectBase`](ObjectBase).[`id`](ObjectBase#id)

***

### om

#### Get Signature

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`ObjectBase`](ObjectBase).[`om`](ObjectBase#om)

## Methods

### free()

```ts
free(): void;
```

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`free`](ObjectBase#free)

***

### getStream()

```ts
getStream(): Uint8Array<ArrayBufferLike>;
```

Gets the Uint8Array containing the content of this FileInfo,
or null if the file specification is empty.

#### Returns

`Uint8Array`&lt;`ArrayBufferLike`&gt;

***

### rebind()

```ts
rebind(omTo): void;
```

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`rebind`](ObjectBase#rebind)