使用信封ID(Assembly DocuSign.eSign)删除DocuSign上的特定文档

时间:2019-06-05 14:48:32

标签: c# docusignapi document delete-file

我在C#中使用DocuSign.eSign dll。 我想从Docusign删除文档(信封)

我使用了“ EnvelopesApi”类公开的方法,例如“ DeleteDocuments”。但这实际上是从草稿信封中删除文档,但是我想删除在docusign生成的任何信封。

EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition
    {
        EnvelopeId = envelopId
    };
    envelopesApi.DeleteDocuments(accountId, envelopId,                                                          
 envelopeDefinition);

调用此方法后,我希望可以从DocuSign中删除文档(信封),但仍可以使用“ ListDocuments”方法检索文档。请让我知道我在想什么。

1 个答案:

答案 0 :(得分:1)

这里有两个选项,因此您可能想弄清楚您要寻找的是什么。

  1. 删除信封。删除信封实际上并不会从DocuSign系统中删除它,而只是删除了用户指向它的指针,因此它不再显示在其“管理”选项卡中。要删除信封,请使用Folders::MoveEnvelopes方法,其文件夹ID为“ recyclebin”。请注意,如果发件人删除“处理中”信封,则该信封将作废。

    此示例显示了如何删除两个信封:

        FoldersApi foldersApi = new FoldersApi(apiClient.Configuration);
    
        FoldersRequest foldersRequest = new FoldersRequest();
        foldersRequest.EnvelopeIds = new List<string>();
        foldersRequest.EnvelopeIds.Add("000-111-222");
        foldersRequest.EnvelopeIds.Add("333-444-555");
    
        foldersApi.MoveEnvelopes(accountId, "recyclebin", foldersRequest);
    
  2. 清除信封。已清除的信封已从DocuSign中完全移除,仅存根记录和完成证书将保留。此处提供更多清除信息的方法:https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes 请注意,清除信封会向所有使用DocuSign帐户的收件人发送通知,并且延迟两周的时间允许他们访问信封,然后再将其删除。

    要将队列放入“清除”队列,应使用Envelopes::Update方法。通过SDK调用此方法时,建议您创建一个空的Envelope对象,在其中设置PurgeState,然后使用Update()方法应用该对象。

        EnvelopesApi envelopesApi = new EnvelopesApi(apiClient.Configuration);
        string envelopeId = "000-111-222";
    
        Envelope purgeEnvelope = new Envelope
        {
            PurgeState = "documents_queued" //change to "documents_and_metadata_queued" to also remove recipient info
        };
    
        envelopesApi.Update(accountId, envelopeId, purgeEnvelope);