# Documents

Handles all Security Token Document related functionality

## Hierarchy

* Namespace‹[SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken)›

  ↳ **Documents**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)
* [set](#set)

### Methods

* [get](#get)

## Properties

### `Protected` context

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

*Inherited from void*

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

### `Protected` parent

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

*Inherited from void*

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

### set

• **set**: *ProcedureMethod‹*[*SetTokenDocumentsParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/settokendocumentsparams)*,* [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/classes/securitytoken)*›*

*Defined in* [*src/api/entities/SecurityToken/Documents.ts:38*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Documents.ts#L38)

Assign a new list of documents to the Security Token by replacing the existing list of documents with the one passed in the parameters

This requires two transactions

**`param`** new list of documents

**`note`** required role:

* Security Token Owner

## Methods

### get

▸ **get**(`paginationOpts?`: [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions)): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/resultset)*‹*[*TokenDocument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/tokendocument)*››*

*Defined in* [*src/api/entities/SecurityToken/Documents.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/a0872cf4/src/api/entities/SecurityToken/Documents.ts#L45)

Retrieve all documents linked to the Security Token

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `paginationOpts?` | [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v4/interfaces/paginationoptions) |

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