DocuSign.Api.EnvelopeViews (DocuSign v0.3.4) View Source

API calls for all endpoints tagged EnvelopeViews.

Link to this section Summary

Functions

Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.

Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :recipient_view_request (RecipientViewRequest):

Returns

} on success {:error, info} on failure

Returns a URL to the recipient view UI. Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony. ###### Note: Please redirect the client to the URL. iFrames should not be used, especially if the recipient may be using a mobile or tablet. This method is only used with envelopes in the `sent` status. Your application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters `assertionId`, `authenticationInstant`, `authenticationMethod`, `clientUserId`, and `securityDomain` to record information on how the recipient was authenticated. At a minimum, `authenticationMethod` and `clientUserId` are required. The information that you provide is included in the envelope's certificate of completion. ## The event status parameter After the signer completes or ends the signing ceremony, DocuSign will redirect the user's browser back to your app via the `returnUrl` that you supply. DocuSIgn appends an `event` query parameter to the URL with the outcome of the signing ceremony. Your app should use the event parameter to determine the next step for the envelope. Don't fetch the envelope's status via Envelopes: get or a similar method; that could break the DocuSign rule against polling. ## The URL is time-limited The URL returned by this method is valid for one use. It must be used/displayed within a couple of minutes after being generated. Once the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out. Because the URL is time-limited, it should not be stored or sent via email. Immediately redirect the user's browser to the URL after you receive it. If you want to invite someone to an embedded signing session via email, the email invitation's URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL. ## Maintaining State After the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the `returnUrl` field. Eg, `https://myapp.eg.com/docusign_return?myState=12345` When the user is redirected to your app, the `event` query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.

Returns a URL to the sender view UI. Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications. The returned URL can only be redirected to immediately after it is generated. It can only be used once. Therefore, request the URL immediately before you redirect your user to it. For the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView. Multiple solutions are available for maintaining your client state. See the "Maintaining State" section of the Embedded Signing introduction. After the user has completed the sending view, their browser is redirected to the `returnUrl` you supplied. By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL. To start with the envelope's recipients and documents view instead, examine the URL in the method's response. Then change the query parameter from `send=1` to `send=0` to start with the recipients/documents view.

Link to this section Functions

Link to this function

views_post_account_console_view(connection, account_id, opts \\ [])

View Source

Specs

views_post_account_console_view(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.EnvelopeViews.t()} | {:error, Tesla.Env.t()}

Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :console_view_request (ConsoleViewRequest):

Returns

} on success {:error, info} on failure

Link to this function

views_post_envelope_correct_view(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

views_post_envelope_correct_view(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeViews.t()} | {:error, Tesla.Env.t()}

Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :correct_view_request (CorrectViewRequest):

Returns

} on success {:error, info} on failure

Link to this function

views_post_envelope_edit_view(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

views_post_envelope_edit_view(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeViews.t()} | {:error, Tesla.Env.t()}

Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :return_url_request (ReturnUrlRequest):

Returns

} on success {:error, info} on failure

Link to this function

views_post_envelope_recipient_shared_view(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

views_post_envelope_recipient_shared_view(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.TemplateViews.t()} | {:error, Tesla.Env.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :recipient_view_request (RecipientViewRequest):

Returns

} on success {:error, info} on failure

Link to this function

views_post_envelope_recipient_view(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

views_post_envelope_recipient_view(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeViews.t()} | {:error, Tesla.Env.t()}

Returns a URL to the recipient view UI. Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony. ###### Note: Please redirect the client to the URL. iFrames should not be used, especially if the recipient may be using a mobile or tablet. This method is only used with envelopes in the `sent` status. Your application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters `assertionId`, `authenticationInstant`, `authenticationMethod`, `clientUserId`, and `securityDomain` to record information on how the recipient was authenticated. At a minimum, `authenticationMethod` and `clientUserId` are required. The information that you provide is included in the envelope's certificate of completion. ## The event status parameter After the signer completes or ends the signing ceremony, DocuSign will redirect the user's browser back to your app via the `returnUrl` that you supply. DocuSIgn appends an `event` query parameter to the URL with the outcome of the signing ceremony. Your app should use the event parameter to determine the next step for the envelope. Don't fetch the envelope's status via Envelopes: get or a similar method; that could break the DocuSign rule against polling. ## The URL is time-limited The URL returned by this method is valid for one use. It must be used/displayed within a couple of minutes after being generated. Once the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out. Because the URL is time-limited, it should not be stored or sent via email. Immediately redirect the user's browser to the URL after you receive it. If you want to invite someone to an embedded signing session via email, the email invitation's URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL. ## Maintaining State After the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the `returnUrl` field. Eg, `https://myapp.eg.com/docusign_return?myState=12345` When the user is redirected to your app, the `event` query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :recipient_view_request (RecipientViewRequest):

Returns

} on success {:error, info} on failure

Link to this function

views_post_envelope_sender_view(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

views_post_envelope_sender_view(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeViews.t()} | {:error, Tesla.Env.t()}

Returns a URL to the sender view UI. Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications. The returned URL can only be redirected to immediately after it is generated. It can only be used once. Therefore, request the URL immediately before you redirect your user to it. For the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView. Multiple solutions are available for maintaining your client state. See the "Maintaining State" section of the Embedded Signing introduction. After the user has completed the sending view, their browser is redirected to the `returnUrl` you supplied. By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL. To start with the envelope's recipients and documents view instead, examine the URL in the method's response. Then change the query parameter from `send=1` to `send=0` to start with the recipients/documents view.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :return_url_request (ReturnUrlRequest):

Returns

} on success {:error, info} on failure