# RemoveDocument

Procedure that removes a document from a Security Token

## Type parameters

▪ **ReturnType**

## Hierarchy

*   Procedure‹[RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs)›

    ↳ **RemoveDocument**

## Index

### Constructors

* [constructor](#constructor)

### Properties

* [args](#protected-args)
* [context](#protected-context)
* [type](#type)

### Methods

* [addProcedure](#addprocedure)
* [addSignatureRequest](#addsignaturerequest)
* [addTransaction](#addtransaction)
* [prepare](#prepare)
* [prepareTransactions](#preparetransactions)

## Constructors

### constructor

\+ **new RemoveDocument**(`args`: [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs), `context`: [Context](_context_.context)): [_RemoveDocument_](_procedures_removedocument_.removedocument)

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:40_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L40)

**Parameters:**

| Name      | Type                                                                                   |
| --------- | -------------------------------------------------------------------------------------- |
| `args`    | [RemoveDocumentProcedureArgs](../interfaces/_types_index_.removedocumentprocedureargs) |
| `context` | [Context](_context_.context)                                                           |

**Returns:** [_RemoveDocument_](_procedures_removedocument_.removedocument)

## Properties

### `Protected` args

• **args**: [_RemoveDocumentProcedureArgs_](../interfaces/_types_index_.removedocumentprocedureargs)

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:34_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L34)

### `Protected` context

• **context**: [_Context_](_context_.context)

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:36_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L36)

### type

• **type**: [_ProcedureType_](../enums/_types_index_.proceduretype) = ProcedureType.RemoveDocument

_Overrides void_

_Defined in_ [_src/procedures/RemoveDocument.ts:15_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L15)

## Methods

### addProcedure

▸ **addProcedure**<**A**, **R**>(`Proc`: [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass)‹A, R›): _(Anonymous function)_

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:91_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L91)

Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

**Type parameters:**

▪ **A**

▪ **R**: _any_

**Parameters:**

| Name   | Type                                                                        | Description                                                      |
| ------ | --------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `Proc` | [ProcedureClass](../interfaces/_procedures_procedure_.procedureclass)‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue |

**Returns:** _(Anonymous function)_

whichever value is returned by the Procedure

### addSignatureRequest

▸ **addSignatureRequest**<**A**>(`request`: [SignatureRequest](../../external-modules/_types_index_#signaturerequest)‹A›): _(Anonymous function)_

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:179_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L179)

Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

**Type parameters:**

▪ **A**

**Parameters:**

| Name      | Type                                                                         | Description                                                              |
| --------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `request` | [SignatureRequest](../../external-modules/_types_index_#signaturerequest)‹A› | A signature request that will be run in the Procedure's TransactionQueue |

**Returns:** _(Anonymous function)_

a PostTransactionResolver that resolves to the signed data

### addTransaction

▸ **addTransaction**<**A**, **R**, **V**>(`method`: [LowLevelMethod](../../external-modules/_types_index_#lowlevelmethod)‹A› | [FutureLowLevelMethod](../interfaces/_types_index_.futurelowlevelmethod)‹V, A›, `__namedParameters`: object): _(Anonymous function)_

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:137_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L137)

Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

**Type parameters:**

▪ **A**

▪ **R**: _any\[]_

▪ **V**: _any_

**Parameters:**

▪ **method**: [_LowLevelMethod_](../../external-modules/_types_index_#lowlevelmethod)_‹A› |_ [_FutureLowLevelMethod_](../interfaces/_types_index_.futurelowlevelmethod)_‹V, A›_

A method (or future method) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time (for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run)

▪`Default value` **\_\_namedParameters**: _object_= {}

| Name        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Default                           |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `fees`      | undefined \| [Fees](../interfaces/_types_index_.fees)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | -                                 |
| `resolvers` | object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | (\[] as unknown) as ResolverArray |
| `tag`       | undefined \| [Any](../../enums/_types_index_.polytransactiontag#any) \| [GetTokens](../../enums/_types_index_.polytransactiontag#gettokens) \| [ApproveErc20](../../enums/_types_index_.polytransactiontag#approveerc20) \| [TransferErc20](../../enums/_types_index_.polytransactiontag#transfererc20) \| [ReserveSecurityToken](../../enums/_types_index_.polytransactiontag#reservesecuritytoken) \| [CreateSecurityToken](../../enums/_types_index_.polytransactiontag#createsecuritytoken) \| [CreateCheckpoint](../../enums/_types_index_.polytransactiontag#createcheckpoint) \| [CreateErc20DividendDistribution](../../enums/_types_index_.polytransactiontag#createerc20dividenddistribution) \| [SetErc20TaxWithholding](../../enums/_types_index_.polytransactiontag#seterc20taxwithholding) \| [SetEtherTaxWithholding](../../enums/_types_index_.polytransactiontag#setethertaxwithholding) \| [SetDefaultExcluded](../../enums/_types_index_.polytransactiontag#setdefaultexcluded) \| [EnableDividends](../../enums/_types_index_.polytransactiontag#enabledividends) \| [EnableCappedSto](../../enums/_types_index_.polytransactiontag#enablecappedsto) \| [EnableTieredSto](../../enums/_types_index_.polytransactiontag#enabletieredsto) \| [EnableGeneralPermissionManager](../../enums/_types_index_.polytransactiontag#enablegeneralpermissionmanager) \| [EnableGeneralTransferManager](../../enums/_types_index_.polytransactiontag#enablegeneraltransfermanager) \| [EnableCountTransferManager](../../enums/_types_index_.polytransactiontag#enablecounttransfermanager) \| [EnablePercentageTransferManager](../../enums/_types_index_.polytransactiontag#enablepercentagetransfermanager) \| [DisableController](../../enums/_types_index_.polytransactiontag#disablecontroller) \| [FreezeIssuance](../../enums/_types_index_.polytransactiontag#freezeissuance) \| [DisableFeature](../../enums/_types_index_.polytransactiontag#disablefeature) \| [ReclaimDividendFunds](../../enums/_types_index_.polytransactiontag#reclaimdividendfunds) \| [WithdrawTaxWithholdings](../../enums/_types_index_.polytransactiontag#withdrawtaxwithholdings) \| [PushDividendPayment](../../enums/_types_index_.polytransactiontag#pushdividendpayment) \| [PullDividendPayment](../../enums/_types_index_.polytransactiontag#pulldividendpayment) \| [SetDividendsWallet](../../enums/_types_index_.polytransactiontag#setdividendswallet) \| [AddDelegate](../../enums/_types_index_.polytransactiontag#adddelegate) \| [ChangePermission](../../enums/_types_index_.polytransactiontag#changepermission) \| [ControllerTransfer](../../enums/_types_index_.polytransactiontag#controllertransfer) \| [ControllerRedeem](../../enums/_types_index_.polytransactiontag#controllerredeem) \| [PauseSto](../../enums/_types_index_.polytransactiontag#pausesto) \| [UnpauseSto](../../enums/_types_index_.polytransactiontag#unpausesto) \| [FinalizeSto](../../enums/_types_index_.polytransactiontag#finalizesto) \| [SetController](../../enums/_types_index_.polytransactiontag#setcontroller) \| [SetDocument](../../enums/_types_index_.polytransactiontag#setdocument) \| [RemoveDocument](../../enums/_types_index_.polytransactiontag#removedocument) \| [ModifyKycDataMulti](../../enums/_types_index_.polytransactiontag#modifykycdatamulti) \| [ModifyInvestorFlagMulti](../../enums/_types_index_.polytransactiontag#modifyinvestorflagmulti) \| [IssueMulti](../../enums/_types_index_.polytransactiontag#issuemulti) \| [AllowPreMinting](../../enums/_types_index_.polytransactiontag#allowpreminting) \| [RevokePreMinting](../../enums/_types_index_.polytransactiontag#revokepreminting) \| [ChangeAllowBeneficialInvestments](../../enums/_types_index_.polytransactiontag#changeallowbeneficialinvestments) \| [ModifyTimes](../../enums/_types_index_.polytransactiontag#modifytimes) \| [ModifyFunding](../../enums/_types_index_.polytransactiontag#modifyfunding) \| [ModifyAddresses](../../enums/_types_index_.polytransactiontag#modifyaddresses) \| [ModifyTiers](../../enums/_types_index_.polytransactiontag#modifytiers) \| [ModifyLimits](../../enums/_types_index_.polytransactiontag#modifylimits) \| [ModifyOracles](../../enums/_types_index_.polytransactiontag#modifyoracles) \| [BuyWithScRateLimited](../../enums/_types_index_.polytransactiontag#buywithscratelimited) \| [BuyWithPolyRateLimited](../../enums/_types_index_.polytransactiontag#buywithpolyratelimited) \| [BuyWithEthRateLimited](../../enums/_types_index_.polytransactiontag#buywithethratelimited) \| [BuyTokens](../../enums/_types_index_.polytransactiontag#buytokens) \| [BuyTokensWithPoly](../../enums/_types_index_.polytransactiontag#buytokenswithpoly) \| [ChangeHolderCount](../../enums/_types_index_.polytransactiontag#changeholdercount) \| [ChangeHolderPercentage](../../enums/_types_index_.polytransactiontag#changeholderpercentage) \| [ModifyWhitelistMulti](../../enums/_types_index_.polytransactiontag#modifywhitelistmulti) \| [SetAllowPrimaryIssuance](../../enums/_types_index_.polytransactiontag#setallowprimaryissuance) \| [TransferSecurityTokens](../../enums/_types_index_.polytransactiontag#transfersecuritytokens) \| [UnfreezeTransfers](../../enums/_types_index_.polytransactiontag#unfreezetransfers) \| [FreezeTransfers](../../enums/_types_index_.polytransactiontag#freezetransfers) \| [Signature](../../enums/_types_index_.polytransactiontag#signature) \| [TransferReservationOwnership](../../enums/_types_index_.polytransactiontag#transferreservationownership) \| [TransferOwnership](../../enums/_types_index_.polytransactiontag#transferownership) | -                                 |

**Returns:** _(Anonymous function)_

a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed

### prepare

▸ **prepare**(): _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue)_‹Args, ReturnType››_

_Inherited from void_

_Defined in_ [_src/procedures/Procedure.ts:52_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/Procedure.ts#L52)

Mandatory method that builds a list of transactions that will be run

**Returns:** _Promise‹_[_TransactionQueue_](_entities_transactionqueue_.transactionqueue)_‹Args, ReturnType››_

### prepareTransactions

▸ **prepareTransactions**(): _Promise‹void›_

_Overrides void_

_Defined in_ [_src/procedures/RemoveDocument.ts:25_](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/procedures/RemoveDocument.ts#L25)

Remove a document from the Security Token

Note that this procedure will fail if:

* The current wallet is not the Security Token owner
* The name of the document is less than 1 or more than 32 characters long
* The document doesn't exist in the Security Token

**Returns:** _Promise‹void›_
