# Documents

Handles all Security Token Document related functionality

## Hierarchy

* Namespace‹[SecurityToken](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)›

  ↳ **Documents**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v2/classes/documents.md#protected-context)
* [parent](/polymesh-sdk-api-reference/docs-v2/classes/documents.md#protected-parent)

### Methods

* [get](/polymesh-sdk-api-reference/docs-v2/classes/documents.md#get)
* [set](/polymesh-sdk-api-reference/docs-v2/classes/documents.md#set)

## Properties

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v2/classes/context.md)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:12*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/Namespace.ts#L12)

### `Protected` parent

• **parent**: [*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:10*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/Namespace.ts#L10)

## Methods

### get

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

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

Retrieve all documents linked to the Security Token

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](/polymesh-sdk-api-reference/docs-v2/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v2/interfaces/resultset.md)*‹*[*TokenDocument*](/polymesh-sdk-api-reference/docs-v2/interfaces/tokendocument.md)*››*

### set

▸ **set**(`args`: [SetTokenDocumentsParams](/polymesh-sdk-api-reference/docs-v2/interfaces/settokendocumentsparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*››*

*Defined in* [*src/api/entities/SecurityToken/Documents.ts:25*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/api/entities/SecurityToken/Documents.ts#L25)

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

**Parameters:**

| Name   | Type                                                                                                 |
| ------ | ---------------------------------------------------------------------------------------------------- |
| `args` | [SetTokenDocumentsParams](/polymesh-sdk-api-reference/docs-v2/interfaces/settokendocumentsparams.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*››*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v2/classes/documents.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.