---
url: https://docs.moqtail.dev/ts/api/model/classes/IncludeProperties.md
---
# Class: IncludeProperties

Whether the response carries Track Properties: the OK answering a SUBSCRIBE,
TRACK_STATUS or FETCH, or each PUBLISH a SUBSCRIBE_TRACKS brings. With 0 the
Track Properties field is still there, but empty.
Allowed wire values: 0 or 1; any other value is a PROTOCOL_VIOLATION.
Default (when omitted) is 1 (include them).

## Implements

* [`Parameter`](../interfaces/Parameter.md)

## Constructors

### Constructor

> **new IncludeProperties**(`include`): `IncludeProperties`

#### Parameters

##### include

`boolean`

#### Returns

`IncludeProperties`

## Properties

### include

> `readonly` **include**: `boolean`

***

### TYPE

> `readonly` `static` **TYPE**: [`IncludeProperties`](../enumerations/MessageParameterType.md#includeproperties) = `MessageParameterType.IncludeProperties`

## Methods

### toKeyValuePair()

> **toKeyValuePair**(): [`KeyValuePair`](KeyValuePair.md)

#### Returns

[`KeyValuePair`](KeyValuePair.md)

#### Implementation of

[`Parameter`](../interfaces/Parameter.md).[`toKeyValuePair`](../interfaces/Parameter.md#tokeyvaluepair)

***

### fromKeyValuePair()

> `static` **fromKeyValuePair**(`pair`): `IncludeProperties` | `undefined`

#### Parameters

##### pair

[`KeyValuePair`](KeyValuePair.md)

#### Returns

`IncludeProperties` | `undefined`
