Image to PDF / Golang Reference

class ImageToPdfClient

All setter methods return ImageToPdfClient object unless specified otherwise.

Constructor

func NewImageToPdfClient(userName string, apiKey string) ImageToPdfClient

Constructor for the PDFCrowd API client.

Parameters:
  • userName - Your username at PDFCrowd.
  • apiKey - Your API key.

Conversion Input

func (client *ImageToPdfClient) ConvertUrl(url string) ([]byte, error)

Convert an image.

Parameter:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
Returns:
[]byte - Byte array containing the conversion output.

func (client *ImageToPdfClient) ConvertUrlToStream(url string, outStream io.Writer) error

Convert an image and write the result to an output stream.

Parameters:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

func (client *ImageToPdfClient) ConvertUrlToFile(url string, filePath string) error

Convert an image and write the result to a local file.

Parameters:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • filePath - The output file path.

func (client *ImageToPdfClient) ConvertFile(file string) ([]byte, error)

Convert a local file.

Parameter:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
Returns:
[]byte - Byte array containing the conversion output.

func (client *ImageToPdfClient) ConvertFileToStream(file string, outStream io.Writer) error

Convert a local file and write the result to an output stream.

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

func (client *ImageToPdfClient) ConvertFileToFile(file string, filePath string) error

Convert a local file and write the result to a local file.

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • filePath - The output file path.

func (client *ImageToPdfClient) ConvertRawData(data []byte) ([]byte, error)

Convert raw data.

Parameter:
  • data (byte[]) - The raw content to be converted.
Returns:
[]byte - Byte array with the output.

func (client *ImageToPdfClient) ConvertRawDataToStream(data []byte, outStream io.Writer) error

Convert raw data and write the result to an output stream.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

func (client *ImageToPdfClient) ConvertRawDataToFile(data []byte, filePath string) error

Convert raw data to a file.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • filePath - The output file path.

func (client *ImageToPdfClient) ConvertStream(inStream io.Reader) ([]byte, error)

Convert the contents of an input stream.

Parameter:
  • inStream (InputStream) - The input stream with source data.
Returns:
[]byte - Byte array containing the conversion output.

func (client *ImageToPdfClient) ConvertStreamToStream(inStream io.Reader, outStream io.Writer) error

Convert the contents of an input stream and write the result to an output stream.

Parameters:
  • inStream (InputStream) - The input stream with source data.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

func (client *ImageToPdfClient) ConvertStreamToFile(inStream io.Reader, filePath string) error

Convert the contents of an input stream and write the result to a local file.

Parameters:
  • inStream (InputStream) - The input stream with source data.
  • filePath - The output file path.

Image Operations

Settings used for operations with images.

func (client *ImageToPdfClient) SetResize(resize string) *ImageToPdfClient

Resize the image.

Parameter:
  • resize - The resize percentage or new image dimensions.
    Default:
    100%
Examples:
  • Enlarge for high-res display: SetResize("200%")
  • Standard XGA screen resolution: SetResize("1024x768")

func (client *ImageToPdfClient) SetRotate(rotate string) *ImageToPdfClient

Rotate the image.

Parameter:
  • rotate - The rotation specified in degrees.

func (client *ImageToPdfClient) SetCropAreaX(x string) *ImageToPdfClient

Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.

Parameter:
  • x
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
Examples:
  • Crop extends beyond left edge: SetCropAreaX("-1in")
  • Skip narrow border area: SetCropAreaX("10mm")

func (client *ImageToPdfClient) SetCropAreaY(y string) *ImageToPdfClient

Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.

Parameter:
  • y
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
Examples:
  • Crop extends beyond left edge: SetCropAreaY("-1in")
  • Skip narrow border area: SetCropAreaY("10mm")

func (client *ImageToPdfClient) SetCropAreaWidth(width string) *ImageToPdfClient

Set the width of the content area. It should be at least 1 inch.

Parameter:
  • width
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The width of the print area.
Examples:
  • Standard document crop width: SetCropAreaWidth("8in")
  • Full A4 page width crop: SetCropAreaWidth("210mm")

func (client *ImageToPdfClient) SetCropAreaHeight(height string) *ImageToPdfClient

Set the height of the content area. It should be at least 1 inch.

Parameter:
  • height
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The height of the print area.
Examples:
  • Standard document crop width: SetCropAreaHeight("8in")
  • Full A4 page width crop: SetCropAreaHeight("210mm")

func (client *ImageToPdfClient) SetCropArea(x string, y string, width string, height string) *ImageToPdfClient

Set the content area position and size. The content area enables to specify the part to be converted.

Parameters:
  • x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
  • y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
  • width - Set the width of the content area. It should be at least 1 inch.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The width of the print area.
  • height - Set the height of the content area. It should be at least 1 inch.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The height of the print area.

func (client *ImageToPdfClient) SetRemoveBorders(value bool) *ImageToPdfClient

Remove borders of an image which does not change in color.

Parameter:
  • value (bool) - Set to true to remove borders.
    Default:
    false

Page Setup

func (client *ImageToPdfClient) SetPageSize(size string) *ImageToPdfClient

Set the output page size.

Parameter:
  • size
    Allowed Values:
    • A0
    • A1
    • A2
    • A3
    • A4
    • A5
    • A6
    • Letter

func (client *ImageToPdfClient) SetPageWidth(width string) *ImageToPdfClient

Set the output page width.

Parameter:
  • width
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A4 landscape / A3 portrait width: SetPageWidth("297mm")
  • US Letter/Legal standard width: SetPageWidth("8.5in")

func (client *ImageToPdfClient) SetPageHeight(height string) *ImageToPdfClient

Set the output page height.

Parameter:
  • height
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A3 standard height for posters: SetPageHeight("420mm")
  • US Letter standard height: SetPageHeight("11in")

func (client *ImageToPdfClient) SetPageDimensions(width string, height string) *ImageToPdfClient

Set the output page dimensions. If no page size is specified, margins are applied as a border around the image.

Parameters:
  • width - Set the output page width.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • height - Set the output page height.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A4 portrait dimensions: SetPageDimensions("210mm", "297mm")
  • US Letter dimensions: SetPageDimensions("8.5in", "11in")
  • A3 portrait dimensions: SetPageDimensions("297mm", "420mm")

func (client *ImageToPdfClient) SetOrientation(orientation string) *ImageToPdfClient

Set the output page orientation.

Parameter:
  • orientation
    Allowed Values:
    • landscape
    • portrait
    Default:
    portrait

func (client *ImageToPdfClient) SetPosition(position string) *ImageToPdfClient

Set the image position on the page.

Parameter:
  • position
    Allowed Values:
    • center
    • top
    • bottom
    • left
    • right
    • top-left
    • top-right
    • bottom-left
    • bottom-right
    Default:
    center

func (client *ImageToPdfClient) SetPrintPageMode(mode string) *ImageToPdfClient

Set the mode to print the image on the content area of the page.

Parameter:
  • mode
    Allowed Values:
    • default — No image scaling.
    • fit — Fit image to page with aspect ratio.
    • stretch — Stretch image to the page with no aspect ratio.
    Default:
    default

func (client *ImageToPdfClient) SetMarginTop(top string) *ImageToPdfClient

Set the output page top margin.

Parameter:
  • top
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: SetMarginTop("1in")
  • Narrow professional margin: SetMarginTop("10mm")

func (client *ImageToPdfClient) SetMarginRight(right string) *ImageToPdfClient

Set the output page right margin.

Parameter:
  • right
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: SetMarginRight("1in")
  • Narrow professional margin: SetMarginRight("10mm")

func (client *ImageToPdfClient) SetMarginBottom(bottom string) *ImageToPdfClient

Set the output page bottom margin.

Parameter:
  • bottom
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: SetMarginBottom("1in")
  • Narrow professional margin: SetMarginBottom("10mm")

func (client *ImageToPdfClient) SetMarginLeft(left string) *ImageToPdfClient

Set the output page left margin.

Parameter:
  • left
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: SetMarginLeft("1in")
  • Narrow professional margin: SetMarginLeft("10mm")

func (client *ImageToPdfClient) SetPageMargins(top string, right string, bottom string, left string) *ImageToPdfClient

Set the output page margins.

Parameters:
  • top - Set the output page top margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • right - Set the output page right margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • bottom - Set the output page bottom margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • left - Set the output page left margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

func (client *ImageToPdfClient) SetPageBackgroundColor(color string) *ImageToPdfClient

The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.

Parameter:
  • color
    Constraint:
    • The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
  • red color: SetPageBackgroundColor("FF0000")
  • green color: SetPageBackgroundColor("00ff00")
  • green color with 50% opacity: SetPageBackgroundColor("00ff0080")

func (client *ImageToPdfClient) SetDpi(dpi int) *ImageToPdfClient

Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).

Parameter:
  • dpi (int) - The DPI value.
    Default:
    96
Example:
  • The DPI used for printers. 1 inch contains 300 points: SetDpi(300)

Watermark & Background

func (client *ImageToPdfClient) SetPageWatermark(watermark string) *ImageToPdfClient

Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.

Parameter:
  • watermark - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • Multi-page PDF for watermarking: SetPageWatermark("/home/user/john/watermark.pdf")
  • Transparent PNG overlay: SetPageWatermark("/home/user/john/watermark.png")

func (client *ImageToPdfClient) SetPageWatermarkUrl(url string) *ImageToPdfClient

Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download watermark from server: SetPageWatermarkUrl("http://myserver.com/watermark.pdf")
  • Remote logo watermark: SetPageWatermarkUrl("http://myserver.com/watermark.png")

func (client *ImageToPdfClient) SetMultipageWatermark(watermark string) *ImageToPdfClient

Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.

Parameter:
  • watermark - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • Multi-page PDF for watermarking: SetMultipageWatermark("/home/user/john/watermark.pdf")
  • Transparent PNG overlay: SetMultipageWatermark("/home/user/john/watermark.png")

func (client *ImageToPdfClient) SetMultipageWatermarkUrl(url string) *ImageToPdfClient

Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download watermark from server: SetMultipageWatermarkUrl("http://myserver.com/watermark.pdf")
  • Remote logo watermark: SetMultipageWatermarkUrl("http://myserver.com/watermark.png")

func (client *ImageToPdfClient) SetPageBackground(background string) *ImageToPdfClient

Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.

Parameter:
  • background - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • PDF template background: SetPageBackground("/home/user/john/background.pdf")
  • Image texture background: SetPageBackground("/home/user/john/background.png")

func (client *ImageToPdfClient) SetPageBackgroundUrl(url string) *ImageToPdfClient

Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download template background: SetPageBackgroundUrl("http://myserver.com/background.pdf")
  • Remote background pattern: SetPageBackgroundUrl("http://myserver.com/background.png")

func (client *ImageToPdfClient) SetMultipageBackground(background string) *ImageToPdfClient

Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.

Parameter:
  • background - The file path to a local file.
    Constraint:
    • The file must exist and not be empty.
Examples:
  • PDF template background: SetMultipageBackground("/home/user/john/background.pdf")
  • Image texture background: SetMultipageBackground("/home/user/john/background.png")

func (client *ImageToPdfClient) SetMultipageBackgroundUrl(url string) *ImageToPdfClient

Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.

Parameter:
  • url
    Constraint:
    • Supported protocols are http:// and https://.
Examples:
  • Download template background: SetMultipageBackgroundUrl("http://myserver.com/background.pdf")
  • Remote background pattern: SetMultipageBackgroundUrl("http://myserver.com/background.png")

PDF Format

Miscellaneous values for PDF output.

func (client *ImageToPdfClient) SetLinearize(value bool) *ImageToPdfClient

Create linearized PDF. This is also known as Fast Web View.

Parameter:
  • value (bool) - Set to true to create linearized PDF.
    Default:
    false

func (client *ImageToPdfClient) SetEncrypt(value bool) *ImageToPdfClient

Encrypt the PDF. This prevents search engines from indexing the contents.

Parameter:
  • value (bool) - Set to true to enable PDF encryption.
    Default:
    false

func (client *ImageToPdfClient) SetUserPassword(password string) *ImageToPdfClient

Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.

Parameter:
  • password - The user password.
Example:
  • Simple document password: SetUserPassword("123456")

func (client *ImageToPdfClient) SetOwnerPassword(password string) *ImageToPdfClient

Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.

Parameter:
  • password - The owner password.
Example:
  • Admin access password: SetOwnerPassword("123456")

func (client *ImageToPdfClient) SetNoPrint(value bool) *ImageToPdfClient

Disallow printing of the output PDF.

Parameter:
  • value (bool) - Set to true to set the no-print flag in the output PDF.
    Default:
    false

func (client *ImageToPdfClient) SetNoModify(value bool) *ImageToPdfClient

Disallow modification of the output PDF.

Parameter:
  • value (bool) - Set to true to set the read-only only flag in the output PDF.
    Default:
    false

func (client *ImageToPdfClient) SetNoCopy(value bool) *ImageToPdfClient

Disallow text and graphics extraction from the output PDF.

Parameter:
  • value (bool) - Set to true to set the no-copy flag in the output PDF.
    Default:
    false

func (client *ImageToPdfClient) SetTitle(title string) *ImageToPdfClient

Set the title of the PDF.

Parameter:
  • title - The title.
Example:
  • Personal CV title: SetTitle("My Resume")

func (client *ImageToPdfClient) SetSubject(subject string) *ImageToPdfClient

Set the subject of the PDF.

Parameter:
  • subject - The subject.
Example:
  • Technical position subject: SetSubject("CV - Software Developer")

func (client *ImageToPdfClient) SetAuthor(author string) *ImageToPdfClient

Set the author of the PDF.

Parameter:
  • author - The author.
Example:
  • Document author name: SetAuthor("John Doe")

func (client *ImageToPdfClient) SetKeywords(keywords string) *ImageToPdfClient

Associate keywords with the document.

Parameter:
  • keywords - The string with the keywords.
Example:
  • Technical skills for searchability: SetKeywords("software developer, Unix, databases")

Viewer Preferences

These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.

func (client *ImageToPdfClient) SetPageLayout(layout string) *ImageToPdfClient

Specify the page layout to be used when the document is opened.

Parameter:
  • layout
    Allowed Values:
    • single-page — Display one page at a time.
    • one-column — Display the pages in one column.
    • two-column-left — Display the pages in two columns, with odd-numbered pages on the left.
    • two-column-right — Display the pages in two columns, with odd-numbered pages on the right.

func (client *ImageToPdfClient) SetPageMode(mode string) *ImageToPdfClient

Specify how the document should be displayed when opened.

Parameter:
  • mode
    Allowed Values:
    • full-screen — Full-screen mode.
    • thumbnails — Thumbnail images are visible.
    • outlines — Document outline is visible.

func (client *ImageToPdfClient) SetInitialZoomType(zoomType string) *ImageToPdfClient

Specify how the page should be displayed when opened.

Parameter:
  • zoomType
    Allowed Values:
    • fit-width — The page content is magnified just enough to fit the entire width of the page within the window.
    • fit-height — The page content is magnified just enough to fit the entire height of the page within the window.
    • fit-page — The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

func (client *ImageToPdfClient) SetInitialPage(page int) *ImageToPdfClient

Display the specified page when the document is opened.

Parameter:
  • page (int)
    Constraint:
    • Must be a positive integer.
Example:
  • Start at second page: SetInitialPage(2)

func (client *ImageToPdfClient) SetInitialZoom(zoom int) *ImageToPdfClient

Specify the initial page zoom in percents when the document is opened.

Parameter:
  • zoom (int)
    Constraint:
    • Must be a positive integer.
Example:
  • Half-size zoom level: SetInitialZoom(50)

func (client *ImageToPdfClient) SetHideToolbar(value bool) *ImageToPdfClient

Specify whether to hide the viewer application's tool bars when the document is active.

Parameter:
  • value (bool) - Set to true to hide tool bars.
    Default:
    false

func (client *ImageToPdfClient) SetHideMenubar(value bool) *ImageToPdfClient

Specify whether to hide the viewer application's menu bar when the document is active.

Parameter:
  • value (bool) - Set to true to hide the menu bar.
    Default:
    false

func (client *ImageToPdfClient) SetHideWindowUi(value bool) *ImageToPdfClient

Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.

Parameter:
  • value (bool) - Set to true to hide ui elements.
    Default:
    false

func (client *ImageToPdfClient) SetFitWindow(value bool) *ImageToPdfClient

Specify whether to resize the document's window to fit the size of the first displayed page.

Parameter:
  • value (bool) - Set to true to resize the window.
    Default:
    false

func (client *ImageToPdfClient) SetCenterWindow(value bool) *ImageToPdfClient

Specify whether to position the document's window in the center of the screen.

Parameter:
  • value (bool) - Set to true to center the window.
    Default:
    false

func (client *ImageToPdfClient) SetDisplayTitle(value bool) *ImageToPdfClient

Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.

Parameter:
  • value (bool) - Set to true to display the title.
    Default:
    false

Miscellaneous

func (client *ImageToPdfClient) SetDebugLog(value bool) *ImageToPdfClient

Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Parameter:
  • value (bool) - Set to true to enable the debug logging.
    Default:
    false

func (client *ImageToPdfClient) GetDebugLogUrl() string

Get the URL of the debug log for the last conversion.

Returns:
string - The link to the debug log.

func (client *ImageToPdfClient) GetRemainingCreditCount() int

Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.

Returns:
int - The number of credits.

func (client *ImageToPdfClient) GetConsumedCreditCount() int

Get the number of credits consumed by the last conversion.

Returns:
int - The number of credits.

func (client *ImageToPdfClient) GetJobId() string

Get the job id.

Returns:
string - The unique job identifier.

func (client *ImageToPdfClient) GetOutputSize() int

Get the size of the output in bytes.

Returns:
int - The count of bytes.

func (client *ImageToPdfClient) GetVersion() string

Get the version details.

Returns:
string - API version, converter version, and client version.

func (client *ImageToPdfClient) SetTag(tag string) *ImageToPdfClient

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

Parameter:
  • tag - A string with the custom tag.
Example:
  • Track job in analytics: SetTag("client-1234")

func (client *ImageToPdfClient) SetHttpProxy(proxy string) *ImageToPdfClient

A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Corporate proxy server: SetHttpProxy("myproxy.com:8080")
  • Direct IP proxy connection: SetHttpProxy("113.25.84.10:33333")

func (client *ImageToPdfClient) SetHttpsProxy(proxy string) *ImageToPdfClient

A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Secure proxy for HTTPS: SetHttpsProxy("myproxy.com:443")
  • Direct secure proxy IP: SetHttpsProxy("113.25.84.10:44333")

API Client Options

func (client *ImageToPdfClient) SetConverterVersion(version string) *ImageToPdfClient

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Availability:
API client >= 5.0.0. See versioning.
Parameter:
  • version - The version identifier.
    Allowed Values:
    • 24.04 — Version 24.04.
    • 20.10 — Version 20.10.
    • 18.10 — Version 18.10.
    • latest — Version 20.10 is used.
    Default:
    24.04

func (client *ImageToPdfClient) SetUseHttp(value bool) *ImageToPdfClient

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Parameter:
  • value (bool) - Set to true to use HTTP.
    Default:
    false

func (client *ImageToPdfClient) SetClientUserAgent(agent string) *ImageToPdfClient

Specifies the User-Agent HTTP header that the client library will use when interacting with the API.

Availability:
API client >= 6.4.0 See versioning.
Parameter:
  • agent - The user agent string.

func (client *ImageToPdfClient) SetUserAgent(agent string) *ImageToPdfClient

Deprecated Replaced with: SetClientUserAgent

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Parameter:
  • agent - The user agent string.
    Default:
    pdfcrowd_go_client/6.5.3 (https://pdfcrowd.com)

func (client *ImageToPdfClient) SetProxy(host string, port int, userName string, password string) *ImageToPdfClient

Specifies an HTTP proxy that the API client library will use to connect to the internet.

Parameters:
  • host - The proxy hostname.
  • port (int) - The proxy port.
  • userName - The username.
  • password - The password.

func (client *ImageToPdfClient) SetRetryCount(count int) *ImageToPdfClient

Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.

Parameter:
  • count (int) - Number of retries.
    Default:
    1
Example:
  • Retry failed requests three times: SetRetryCount(3)