Scraperion.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 |
<?xml version="1.0"?>
<doc> <assembly> <name>Scraperion</name> </assembly> <members> <member name="T:Scraperion.ConnectWebScraper"> <summary> <para type="synopsis">This cmdlet creates a WebScrapper object.</para> <para type="description">This cmdlet creates a WebScrapper object and connects a chromium instance to it.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Credential"> <summary> <para type="description">Credentials to use to connect to page.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Width"> <summary> <para type="description">Width of web page in pixels.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Height"> <summary> <para type="description">Height of web page in pixels.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Url"> <summary> <para type="description">Initial url to connect to.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.ShowUI"> <summary> <para type="description">Pass switch to show chromium browser window. Useful for debugging.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Agent"> <summary> <para type="description">Browser agent to use when browsing pages.</para> </summary> </member> <member name="M:Scraperion.ConnectWebScraper.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.ConvertFromImageToText"> <summary> <para type="synopsis">Converts image to Text</para> <para type="description">Runs OCR over the image and returns the text returend.</para> </summary> </member> <member name="P:Scraperion.ConvertFromImageToText.Image"> <summary> <para type="description">Image to run ocr over.</para> </summary> </member> <member name="M:Scraperion.ConvertFromImageToText.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.DisconnectWebScraper"> <summary> <para type="synopsis">Disconnects Web scrapper</para> <para type="description">Disconnects from chromium and closes it.</para> </summary> </member> <member name="P:Scraperion.DisconnectWebScraper.Scraper"> <summary> <para type="description">Instance of web scrapper to close.</para> </summary> </member> <member name="M:Scraperion.DisconnectWebScraper.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.FrmImage"> <inheritdoc /> <summary> Class used to preview image files by Show-Image cmdlet. </summary> </member> <member name="M:Scraperion.FrmImage.#ctor(System.Drawing.Image)"> <inheritdoc /> <summary> Constructor </summary> <param name="img">Image to preview.</param> </member> <member name="F:Scraperion.FrmImage.components"> <summary> Required designer variable. </summary> </member> <member name="M:Scraperion.FrmImage.Dispose(System.Boolean)"> <summary> Clean up any resources being used. </summary> <param name="disposing">true if managed resources should be disposed; otherwise, false.</param> </member> <member name="M:Scraperion.FrmImage.InitializeComponent"> <summary> Required method for Designer support - do not modify the contents of this method with the code editor. </summary> </member> <member name="T:Scraperion.GetImage"> <summary> <para type="synopsis">Retrives an image</para> <para type="description">Retrives an image ready for use with screen scrapping cmdlets.</para> </summary> </member> <member name="P:Scraperion.GetImage.Path"> <summary> <para type="description">Path to image to load. Can be most common image formats png, bmp, jpg, etc</para> </summary> </member> <member name="P:Scraperion.GetImage.Screen"> <summary> <para type="description">Use this switch to grab a screenshot of the screen.</para> </summary> </member> <member name="P:Scraperion.GetImage.X"> <summary> <para type="description">X coordinates to being capture from</para> </summary> </member> <member name="P:Scraperion.GetImage.Y"> <summary> <para type="description">Y coordinates to being capture from</para> </summary> </member> <member name="P:Scraperion.GetImage.Width"> <summary> <para type="description">Width of capture.</para> </summary> </member> <member name="P:Scraperion.GetImage.Height"> <summary> <para type="description">Height of capture.</para> </summary> </member> <member name="P:Scraperion.GetImage.Image"> <summary> <para type="description">Another image to do capture from, use X, Y, Width and Hight to select a subsection of image.</para> </summary> </member> <member name="M:Scraperion.GetImage.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.GetWebScraperSnapshot"> <summary> <para type="synopsis">Captures a screenshot of current page.</para> <para type="description">Captures a screenshot of the current page.</para> </summary> </member> <member name="P:Scraperion.GetWebScraperSnapshot.Scraper"> <summary> <para type="description">Scrapper object to take screenshot from.</para> </summary> </member> <member name="P:Scraperion.GetWebScraperSnapshot.Pdf"> <summary> <para type="description">Creates a pdf of the target page instead.</para> </summary> </member> <member name="P:Scraperion.GetWebScraperSnapshot.Path"> <summary> <para type="description">Optional path to store the image or pdf.</para> </summary> </member> <member name="M:Scraperion.GetWebScraperSnapshot.ProcessRecord"> <summary> Main cmdlet logic. </summary> </member> <member name="T:Scraperion.InvokeWebScraperExpression"> <summary> <para type="synopsis">Invokes a javascript command</para> <para type="description">Invokes a javascript command in the browser and returns json of what was executed.</para> </summary> </member> <member name="P:Scraperion.InvokeWebScraperExpression.Scraper"> <summary> <para type="description">Scrapper to invoke javascript on.</para> </summary> </member> <member name="P:Scraperion.InvokeWebScraperExpression.Expression"> <summary> <para type="description">Expression to execute.</para> </summary> </member> <member name="M:Scraperion.InvokeWebScraperExpression.ProcessRecord"> <summary> Powershell cmdlet logic </summary> </member> <member name="T:Scraperion.MoveMouse"> <summary> <para type="synopsis">Moves the mouse on the screen.</para> <para type="description">Moves the mouse to target location on the screen.</para> </summary> </member> <member name="P:Scraperion.MoveMouse.X"> <summary> <para type="description">X coordinate to move mouse to on screen</para> </summary> </member> <member name="P:Scraperion.MoveMouse.Y"> <summary> <para type="description">Y coordinate to move mouse to on screen</para> </summary> </member> <member name="M:Scraperion.MoveMouse.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.MoveWebScraperMouse"> <summary> <para type="synopsis">Simulates moving the mouse to a location on the web page.</para> <para type="description">Simulates moving the mouse to a location on the web page.</para> </summary> </member> <member name="P:Scraperion.MoveWebScraperMouse.Scraper"> <summary> <para type="description">Web scrapper object to move mouse on.</para> </summary> </member> <member name="P:Scraperion.MoveWebScraperMouse.X"> <summary> <para type="description">X coordinate to move mouse to on page</para> </summary> </member> <member name="P:Scraperion.MoveWebScraperMouse.Y"> <summary> <para type="description">Y coordinate to move mouse to on page</para> </summary> </member> <member name="M:Scraperion.MoveWebScraperMouse.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SelectImage"> <summary> <para type="synopsis">Finds an image on the screen and clicks it.</para> <para type="description">Finds an image on the screen and clicks it.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Image"> <summary> <para type="description">Image to search for on the screen.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Button"> <summary> <para type="description">Mouse button to use.</para> </summary> </member> <member name="P:Scraperion.SelectImage.XOffset"> <summary> <para type="description">Offset to click on image when found in X axis.</para> </summary> </member> <member name="P:Scraperion.SelectImage.YOffset"> <summary> <para type="description">Offset to click on image when found in Y axis.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Click"> <summary> <para type="description">Click on target image (mouse down then mouse up).</para> </summary> </member> <member name="P:Scraperion.SelectImage.Up"> <summary> <para type="description">Mouse up on target.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Down"> <summary> <para type="description">Mouse down on target.</para> </summary> </member> <member name="M:Scraperion.SelectImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendKeys"> <summary> <para type="synopsis">Send keys to focused application.</para> <para type="description">Simulates key presses on target application. This uses the standard .net send keys syntax. Enter is {ENTER} etc.</para> <para type="description">For more information see https://docs.microsoft.com/en-us/dotnet/framework/winforms/how-to-simulate-mouse-and-keyboard-events-in-code </para> </summary> </member> <member name="P:Scraperion.SendKeys.Text"> <summary> <para type="description">Text top type in .net Standard send keys syntax.</para> </summary> </member> <member name="P:Scraperion.SendKeys.SecureText"> <summary> <para type="description">Decode a secure string and send that instead. Useful for sending passwords.</para> </summary> </member> <member name="P:Scraperion.SendKeys.Credential"> <summary> <para type="description">Sends the contents of a PSCredential object. Will press tab between username and password.</para> </summary> </member> <member name="M:Scraperion.SendKeys.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendMouse"> <summary> <para type="synopsis">Simulate mouse click.</para> <para type="description">Similar to send keys but for the mouse.</para> </summary> </member> <member name="P:Scraperion.SendMouse.Button"> <summary> <para type="description">Button to simulate.</para> </summary> </member> <member name="P:Scraperion.SendMouse.Click"> <summary> <para type="description">Simulate a mouse click (mouse down then mouse up).</para> </summary> </member> <member name="P:Scraperion.SendMouse.Up"> <summary> <para type="description">Simulates a mouse down.</para> </summary> </member> <member name="P:Scraperion.SendMouse.Down"> <summary> <para type="description">Simulates a mouse up.</para> </summary> </member> <member name="M:Scraperion.SendMouse.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendWebScraperKeys"> <summary> <para type="synopsis">Send key presses to browser.</para> <para type="description">Simulate key presses in browser window.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.Scraper"> <summary> <para type="description">Scraper object to send the key presses to.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.Text"> <summary> <para type="description">Text to send to browser window.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.SecureText"> <summary> <para type="description">Decode a secure string and send that instead. Useful for sending passwords.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.Credential"> <summary> <para type="description">Sends the contents of a PSCredential object. Will press tab between username and password.</para> </summary> </member> <member name="M:Scraperion.SendWebScraperKeys.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendWebScraperMouse"> <summary> <para type="synopsis">Sends simulated mouse or tap event to target on page.</para> <para type="description">Simulates a finger press or mouse event on target on page.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Scraper"> <summary> <para type="description">Scraper object to simulat event on.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Button"> <summary> <para type="description">Mouse button to simulate.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Click"> <summary> <para type="description">Simulate a mouse click (mouse down then mouse up).</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Up"> <summary> <para type="description">Simulates a mouse up event.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Down"> <summary> <para type="description">Simulates a mouse down event.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Target"> <summary> <para type="description">Target to apply mouse event to. Use Target selector to specify.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Tap"> <summary> <para type="description">Javascript selector to select object to click on. For more details see https://www.w3schools.com/jsref/met_document_queryselector.asp </para> </summary> </member> <member name="M:Scraperion.SendWebScraperMouse.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SetWebScraperFocus"> <summary> <para type="synopsis">Set element to have focus in web page.</para> <para type="description">Set element in chromium to have focus.</para> </summary> </member> <member name="P:Scraperion.SetWebScraperFocus.Scraper"> <summary> <para type="description">Scraper to set focus on.</para> </summary> </member> <member name="P:Scraperion.SetWebScraperFocus.Target"> <summary> <para type="description">Target to select using javascript selector. For more info see: https://www.w3schools.com/jsref/met_document_queryselector.asp </para> </summary> </member> <member name="M:Scraperion.SetWebScraperFocus.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.ShowImage"> <summary> <para type="synopsis">Shows image</para> <para type="description">Opens a preview window for an image object. Useful for debugging.</para> </summary> </member> <member name="P:Scraperion.ShowImage.Image"> <summary> <para type="description">Image object to preview</para> </summary> </member> <member name="M:Scraperion.ShowImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.Startup"> <summary> Contains code that runs when module is loaded. DPI awareness code needs to be called before any image preview code is done to make screen coordinates work properly. </summary> </member> <member name="M:Scraperion.Startup.OnImport"> <summary> Module startup code </summary> </member> <member name="T:Scraperion.TestImage"> <summary> <para type="synopsis">Return if target image appears on the screen or not.</para> <para type="description">Test if image appears on the screen or not.</para> </summary> </member> <member name="P:Scraperion.TestImage.Image"> <summary> <para type="description">Image to test the existance of.</para> </summary> </member> <member name="P:Scraperion.TestImage.SearchInImage"> <summary> <para type="description">Image to search in. If left blank screen is used instead.</para> </summary> </member> <member name="M:Scraperion.TestImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.WaitImage"> <summary> <para type="synopsis">Wait for image to appear on screen.</para> <para type="description">Wait for image to appear on screen.</para> </summary> </member> <member name="P:Scraperion.WaitImage.Image"> <summary> <para type="description">Image to wait for.</para> </summary> </member> <member name="M:Scraperion.WaitImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.WaitWebScraperExpression"> <summary> <para type="synopsis">Wait for web scrapper expression to be true.</para> <para type="description">Wait for web scrapper expression to be true.</para> </summary> </member> <member name="P:Scraperion.WaitWebScraperExpression.Scraper"> <summary> <para type="description">Scraper to wait on expression to be true.</para> </summary> </member> <member name="P:Scraperion.WaitWebScraperExpression.Expression"> <summary> <para type="description">Javascript expression to test.</para> </summary> </member> <member name="M:Scraperion.WaitWebScraperExpression.ProcessRecord"> <summary> Powershell logic. </summary> </member> </members> </doc> |