# Venue

Represents a Venue through which settlements are handled

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)‹UniqueIdentifiers›

  ↳ **Venue**

## Index

### Properties

* [addInstruction](#addinstruction)
* [context](#protected-context)
* [id](#id)
* [uuid](#uuid)

### Methods

* [details](#details)
* [exists](#exists)
* [getPendingInstructions](#getpendinginstructions)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### addInstruction

• **addInstruction**: *ProcedureMethod‹*[*AddInstructionParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/addinstructionparams)*,* [*Instruction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/instruction)*›*

*Defined in* [*src/api/entities/Venue/index.ts:167*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Venue/index.ts#L167)

Creates a settlement Instruction in this Venue

**`param`** array of token movements (amount, from, to, token)

**`param`** date at which the trade was agreed upon (optional, for offchain trades)

**`param`** date at which the trade was executed (optional, for offchain trades)

**`param`** block at which the Instruction will be executed automatically (optional, the Instruction will be executed when all participants have authorized it if not supplied)

**`note`** required role:

* Venue Owner

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/context)

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Entity.ts#L48)

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/Venue/index.ts:47*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Venue/index.ts#L47)

Identifier number of the venue

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Entity.ts#L46)

## Methods

### details

▸ **details**(): *Promise‹*[*VenueDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/venuedetails)*›*

*Defined in* [*src/api/entities/Venue/index.ts:87*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Venue/index.ts#L87)

Retrieve information specific to this venue

**Returns:** *Promise‹*[*VenueDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/venuedetails)*›*

### exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Venue/index.ts:68*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Venue/index.ts#L68)

Retrieve whether the Venue exists

**Returns:** *Promise‹boolean›*

### getPendingInstructions

▸ **getPendingInstructions**(): *Promise‹*[*Instruction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/instruction)*\[]›*

*Defined in* [*src/api/entities/Venue/index.ts:121*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Venue/index.ts#L121)

Retrieve all pending Instructions in this Venue

**Returns:** *Promise‹*[*Instruction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/instruction)*\[]›*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/entity#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*