Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
oi.u.sms@gmail.com committed Sep 9, 2014
1 parent 752713d commit 5bc4db3
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 33 deletions.
24 changes: 12 additions & 12 deletions aspnet/GrabzIt/GrabzItClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public void SetAnimationOptions(string url)
/// This method sets the parameters required to turn a online video into a animated GIF
/// </summary>
/// <param name="url">The URL of the online video</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified</param>
/// <param name="customId">A custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified</param>
public void SetAnimationOptions(string url, string customId)
{
SetAnimationOptions(url, customId, 0, 0, 0, 0, 0, 0, 0, false, string.Empty, -1, Country.Default);
Expand All @@ -112,7 +112,7 @@ public void SetAnimationOptions(string url, string customId)
/// This method sets the parameters required to turn a online video into a animated GIF
/// </summary>
/// <param name="url">The URL of the online video</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified</param>
/// <param name="customId">A custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified</param>
/// <param name="width">The width of the resulting animated GIF in pixels</param>
/// <param name="height">The height of the resulting animated GIF in pixels</param>
/// <param name="start">The starting position of the video that should be converted into a animated GIF</param>
Expand All @@ -131,7 +131,7 @@ public void SetAnimationOptions(string url, string customId, int width, int heig
/// This method sets the parameters required to turn a online video into a animated GIF
/// </summary>
/// <param name="url">The URL of the online video</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified</param>
/// <param name="customId">A custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified</param>
/// <param name="width">The width of the resulting animated GIF in pixels</param>
/// <param name="height">The height of the resulting animated GIF in pixels</param>
/// <param name="start">The starting position of the video that should be converted into a animated GIF</param>
Expand Down Expand Up @@ -160,7 +160,7 @@ public void SetAnimationOptions(string url, string customId, int width, int heig
/// This method sets the parameters required to take a screenshot of a web page.
/// </summary>
/// <param name="url">The URL that the screenshot should be made of</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot web service. This will be returned with the callback URL you have specified.</param>
/// <param name="browserWidth">The width of the browser in pixels</param>
/// <param name="browserHeight">The height of the browser in pixels</param>
/// <param name="outputHeight">The height of the resulting thumbnail in pixels</param>
Expand Down Expand Up @@ -198,7 +198,7 @@ public void SetImageOptions(string url)
/// This method sets the parameters required to take a screenshot of a web page.
/// </summary>
/// <param name="url">The URL that the screenshot should be made of</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot web service. This will be returned with the callback URL you have specified.</param>
public void SetImageOptions(string url, string customId)
{
SetImageOptions(url, customId, 0, 0, 0, 0, ImageFormat.jpg, 0, string.Empty, BrowserType.StandardBrowser, string.Empty);
Expand All @@ -208,7 +208,7 @@ public void SetImageOptions(string url, string customId)
/// This method sets the parameters required to take a screenshot of a web page.
/// </summary>
/// <param name="url">The URL that the screenshot should be made of</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the screenshot web service. This will be returned with the callback URL you have specified.</param>
/// <param name="browserWidth">The width of the browser in pixels</param>
/// <param name="browserHeight">The height of the browser in pixels</param>
/// <param name="outputHeight">The height of the resulting thumbnail in pixels</param>
Expand All @@ -227,7 +227,7 @@ public void SetImageOptions(string url, string customId, int browserWidth, int b
/// This method sets the parameters required to extract all tables from a web page.
/// </summary>
/// <param name="url">The URL that the should be used to extract tables</param>
/// <param name="customId">A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.</param>
/// <param name="tableNumberToInclude">Which table to include, in order from the begining of the page to the end</param>
/// <param name="format">The format the tableshould be in: csv, xlsx</param>
/// <param name="includeHeaderNames">If true header names will be included in the table</param>
Expand All @@ -250,7 +250,7 @@ public void SetTableOptions(string url, string customId, int tableNumberToInclud
/// This method sets the parameters required to extract all tables from a web page.
/// </summary>
/// <param name="url">The URL that the should be used to extract tables</param>
/// <param name="customId">A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.</param>
/// <param name="tableNumberToInclude">Which table to include, in order from the begining of the page to the end</param>
/// <param name="format">The format the tableshould be in: csv, xlsx</param>
/// <param name="includeHeaderNames">If true header names will be included in the table</param>
Expand All @@ -275,7 +275,7 @@ public void SetTableOptions(string url)
/// This method sets the parameters required to extract all tables from a web page.
/// </summary>
/// <param name="url">The URL that the should be used to extract tables</param>
/// <param name="customId">A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.</param>
public void SetTableOptions(string url, string customId)
{
SetTableOptions(url, string.Empty, 1, TableFormat.csv, true, false, string.Empty, BrowserType.StandardBrowser, Country.Default);
Expand All @@ -285,7 +285,7 @@ public void SetTableOptions(string url, string customId)
/// This method sets the parameters required to convert a web page into a PDF.
/// </summary>
/// <param name="url">The URL that the should be converted into a pdf</param>
/// <param name="customId">A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.</param>
/// <param name="includeBackground">If true the background of the web page should be included in the screenshot</param>
/// <param name="pagesize">The page size of the PDF to be returned: 'A3', 'A4', 'A5', 'B3', 'B4', 'B5', 'Letter'.</param>
/// <param name="orientation">The orientation of the PDF to be returned: 'Landscape' or 'Portrait'</param>
Expand Down Expand Up @@ -326,7 +326,7 @@ public void SetPDFOptions(string url)
/// This method sets the parameters required to convert a web page into a PDF.
/// </summary>
/// <param name="url">The URL that the should be converted into a pdf</param>
/// <param name="customId">A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.</param>
public void SetPDFOptions(string url, string customId)
{
SetPDFOptions(url, customId, true, PageSize.A4, PageOrientation.Portrait, true, false, string.Empty, string.Empty, 10, 10, 10, 10, 0, BrowserType.StandardBrowser, string.Empty);
Expand All @@ -336,7 +336,7 @@ public void SetPDFOptions(string url, string customId)
/// This method sets the parameters required to convert a web page into a PDF.
/// </summary>
/// <param name="url">The URL that the should be converted into a pdf</param>
/// <param name="customId">A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.</param>
/// <param name="customId">A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.</param>
/// <param name="includeBackground">If true the background of the web page should be included in the screenshot</param>
/// <param name="pagesize">The page size of the PDF to be returned: 'A3', 'A4', 'A5', 'B3', 'B4', 'B5', 'Letter'.</param>
/// <param name="orientation">The orientation of the PDF to be returned: 'Landscape' or 'Portrait'</param>
Expand Down
4 changes: 2 additions & 2 deletions java/grabzit/src/it/grabz/grabzit/GrabzItClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public GrabzItClient(String applicationKey, String applicationSecret)
/**
* This method sets the parameters required to turn an online video into a animated GIF.
* @param url The URL of the online video
* @param customId A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified
* @param customId A custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified
* @param width The width of the resulting animated GIF in pixels
* @param height The height of the resulting animated GIF in pixels
* @param start The starting position of the video that should be converted into a animated GIF
Expand All @@ -92,7 +92,7 @@ BASE_URL, encode(url), applicationKey, width, height, duration, toString(speed),
/**
* This method sets the parameters required to turn an online video into a animated GIF.
* @param url The URL of the online video
* @param customId A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified
* @param customId A custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified
* @param width The width of the resulting animated GIF in pixels
* @param height The height of the resulting animated GIF in pixels
* @param start The starting position of the video that should be converted into a animated GIF
Expand Down
12 changes: 12 additions & 0 deletions nodejs/grabzitdemo/node_modules/grabzit/lib/grabzit.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions perl/GrabzIt/GrabzItClient.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ sub new
# This method sets the parameters required to turn a online video into a animated GIF
#
# url - The URL of the online video
# customId - A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified
# customId - A custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified
# width - The width of the resulting animated GIF in pixels
# height - The height of the resulting animated GIF in pixels
# start - The starting position of the video that should be converted into a animated GIF
Expand Down Expand Up @@ -79,7 +79,7 @@ sub SetAnimationOptions($;$$$$$$$$$$$$)
#browserHeight - The height of the browser in pixels
#outputHeight - The height of the resulting thumbnail in pixels
#outputWidth - The width of the resulting thumbnail in pixels
#customId - A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.
#customId - A custom identifier that you can pass through to the screenshot web service. This will be returned with the callback URL you have specified.
#format - The format the screenshot should be in: bmp8, bmp16, bmp24, bmp, gif, jpg, png
#delay - The number of milliseconds to wait before taking the screenshot
#targetElement - The id of the only HTML element in the web page to turn into a screenshot
Expand Down Expand Up @@ -116,9 +116,9 @@ sub SetImageOptions($;$$$$$$$$$$$$)
#
#url - The URL that the should be used to extract tables
#format - The format the tableshould be in: csv, xlsx
#customId - A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.
#customId - A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.
#includeHeaderNames - If true header names will be included in the table
#includeAllTables - If true all table on the web page will be extracted with each table appearing in a seperate spreadsheet sheet. Only available with the XLSX format.
#includeAllTables - If true all table on the web page will be extracted with each table appearing in a separate spreadsheet sheet. Only available with the XLSX format.
#targetElement - The id of the only HTML element in the web page that should be used to extract tables from
#requestAs - Request the screenshot in different forms: Standard Browser = 0, Mobile Browser = 1, Search Engine = 2 and Fallback Browser = 3
#country - request the screenshot from different countries: Default = "", UK = "UK", US = "US"
Expand Down Expand Up @@ -146,7 +146,7 @@ sub SetTableOptions($;$$$$$$$$)
#This method sets the parameters required to convert a web page into a PDF.
#
#url - The URL that the should be converted into a pdf
#customId - A custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.
#customId - A custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.
#includeBackground - If true the background of the web page should be included in the screenshot
#pagesize - The page size of the PDF to be returned: 'A3', 'A4', 'A5', 'B3', 'B4', 'B5', 'Letter'.
#orientation - The orientation of the PDF to be returned: 'Landscape' or 'Portrait'
Expand Down
Loading

0 comments on commit 5bc4db3

Please sign in to comment.