DocuSign.Api.Envelopes.pages_get_page_image

You're seeing just the function pages_get_page_image, go back to DocuSign.Api.Envelopes module for more information.
Link to this function

pages_get_page_image(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

View Source

Specs

pages_get_page_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • page_number (String.t): The page number being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :dpi (String.t): Sets the dpi for the image.
    • :max_height (String.t): Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting.
    • :max_width (String.t): Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting.
    • :show_changes (String.t):

Returns

} on success {:error, info} on failure