# Venue

Represents a Venue through which settlements are handled

## Hierarchy

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

  ↳ **Venue**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

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

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

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/Venue/index.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Venue/index.ts#L45)

Identifier number of the venue

### uuid

• **uuid**: *string*

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

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

## Methods

### addInstruction

▸ **addInstruction**(`args`: [AddInstructionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/addinstructionparams)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/transactionqueue)*‹*[*Instruction*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/classes/instruction)*››*

*Defined in* [*src/api/entities/Venue/index.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Venue/index.ts#L119)

Creates a settlement instruction in this Venue

**Parameters:**

| Name   | Type                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `args` | [AddInstructionParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/interfaces/addinstructionparams) |

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

### details

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

*Defined in* [*src/api/entities/Venue/index.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Venue/index.ts#L61)

Retrieve information specific to this venue

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

### getPendingInstructions

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

*Defined in* [*src/api/entities/Venue/index.ts:86*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/src/api/entities/Venue/index.ts#L86)

Retrieve all pending Instructions in this Venue

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

### `Static` generateUuid

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

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

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/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-v3/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v3/entity#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/1221e467/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*