-
Notifications
You must be signed in to change notification settings - Fork 1
/
APIdoc_Py.xml
2843 lines (2843 loc) · 137 KB
/
APIdoc_Py.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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<api>
<class>
<name>Request</name>
<type>Non-Static</type>
<description>Object that represents a HTTP request. [i[br]]Has methods to create and send HTTP requests.</description>
<constructors>
<constructor>
<name>Request(string FullUrl)</name>
<description>Creates Request object from Url, Request Method defaults to GET.</description>
<parameters>
<parameter>
<datatype>string</datatype>
<name>FullUrl</name>
<description>Url should include the hostname and scheme. [i[br]]Eg: http://ironwasp.org</description>
</parameter>
</parameters>
</constructor>
<constructor>
<name>Request(string Method, string FullUrl)</name>
<description>Creates Request object from Url and sets the mentioned method.</description>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Method</name>
<description>Request method, Eg: GET or POST</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>FullUrl</name>
<description>Url should include the hostname and scheme. [i[br]]Eg: http://ironwasp.org</description>
</parameter>
</parameters>
</constructor>
<constructor>
<name>Request(string Method, string FullUrl, string BodyString)</name>
<description>Creates Request object from Url, sets the mentioned method and sets the body.</description>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Method</name>
<description>Request method, Eg: GET or POST</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>FullUrl</name>
<description>Url should include the hostname and scheme. [i[br]]Eg: http://ironwasp.org/index.html</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>BodyString</name>
<description>Body of the request as string.</description>
</parameter>
</parameters>
</constructor>
</constructors>
<properties>
<property>
<name>FullUrl</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Entire Url along with scheme and hostname.[i[br]]Eg: http://ironwasp.org/index.html</description>
</property>
<property>
<name>Url</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Url without the scheme and hostname.[i[br]]Eg: /main/index.aspx?q=123</description>
</property>
<property>
<name>UrlPath</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>The Path section of the Url without the QueryString.[i[br]]Eg: /main/index.aspx</description>
</property>
<property>
<name>UrlPathParts</name>
<datatype>string[]</datatype>
<type>Non-Static</type>
<description>Array of strings where each element is a part of the UrlPath property.[i[br]]Eg: ['main','index.aspx']</description>
</property>
<property>
<name>SSL</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>Bool value stating if the request is a SSL request or not. [i[br]]Set this to True to create a SSL request.[i[br]]Alias - Ssl</description>
</property>
<property>
<name>Method</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>HTTP Method of the Request. [i[br]]Eg: GET, POST etc.</description>
</property>
<property>
<name>HttpVersion</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Version number of the HTTP Request - HTTP/1.1 or HTTP/1.0</description>
</property>
<property>
<name>Query</name>
<datatype>Parameters</datatype>
<type>Non-Static</type>
<description>Contains the QueryString parameters in a list of Key/Value pairs. [i[br]]Access these parameters using the methods of the Parameter Class</description>
</property>
<property>
<name>Body</name>
<datatype>Parameters</datatype>
<type>Non-Static</type>
<description>Contains the Request Body parameters in a list of Key/Value pairs. [i[br]]Access these parameters using the methods of the Parameter Class</description>
</property>
<property>
<name>Cookie</name>
<datatype>Parameters</datatype>
<type>Non-Static</type>
<description>Contains the Cookie parameters in a list of Key/Value pairs. [i[br]]Access these parameters using the methods of the Parameter Class</description>
</property>
<property>
<name>Headers</name>
<datatype>Parameters</datatype>
<type>Non-Static</type>
<description>Contains the Request Headers in a list of Key/Value pairs. [i[br]]Access these parameters using the methods of the Parameter Class</description>
</property>
<property>
<name>Host</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Hostname of the target server. [i[br]]Eg: www.ironwasp.org</description>
</property>
<property>
<name>HasBody</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value representing the presence of a Body in the Request.</description>
</property>
<property>
<name>BodyString</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Entire Body of the Request as a single string. [i[br]]Encoding charset used is taken from the Content-Type header or ISO-8859-1 is used if none is present.</description>
</property>
<property>
<name>BinaryBodyString</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Entire Body of the Request as a Base64 encoded string. [i[br]]If a Binary Request body must be assigned then it can be assigned to this property or to the BodyArray property.[i[br]](IronWASP stores binary body as base64 string in its logs).</description>
</property>
<property>
<name>BodyArray</name>
<datatype>byte[]</datatype>
<type>Non-Static</type>
<description>Entire Body of the Request as a Byte Array.</description>
</property>
<property>
<name>BodyLength</name>
<datatype>int</datatype>
<type>Non-Static</type>
<description>Length of the Request Body.</description>
</property>
<property>
<name>CookieString</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Gives the value of the 'Cookie' header of the Request. [i[br]]This property can be assigned a new string to update the Cookie value as well.</description>
</property>
<property>
<name>ContentType</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Value of the Content-Type Header, including the Charset information(if present).</description>
</property>
<property>
<name>IsBinary</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Request is in text or binary format. [i[br]] This property can be controlled by setting a suitable value in the HTTP API section of the config panel</description>
</property>
<property>
<name>Response</name>
<datatype>Response</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Response object associated with this Request. [i[br]]Generated on calling the Send() method.</description>
</property>
</properties>
<methods>
<method>
<name>Send()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>Response</return>
<description>Sends the request to the server and returns the Response object. [i[br]]Call blocks the thread.</description>
</method>
<method>
<name>Follow(Response ResponseToFollow)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>Response</datatype>
<name>ResponseToFollow</name>
<description>A 3xx response that must be followed</description>
</parameter>
</parameters>
<return>Response</return>
<description>If the response status code is a 301, 302, 303 or 307 then it is followed else the response passed in is returned.</description>
</method>
<method>
<name>GetRedirect(Response RedirectResponse)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>Response</datatype>
<name>RedirectResponse</name>
<description>Response to the Request which contains a Redirect header</description>
</parameter>
</parameters>
<return>Request</return>
<description>If the response status code is a 301, 302, 303 or 307 then the a Request object specific to follow the redirection is returned.[i[br]]If the Response is not a redirect then a null value is returned.</description>
</method>
<method>
<name>SetCookie(Response Res)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>Response</datatype>
<name>Res</name>
<description>IronWASP Response object</description>
</parameter>
</parameters>
<return>None</return>
<description>Reads the contents of the Set-Cookie headers from the Response object and adds them as cookies in the Request.</description>
</method>
<method>
<name>SetCookie(SetCookie[] SetCookies)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>SetCookie[]</datatype>
<name>SetCookies</name>
<description>A list of SetCookie objects. This is usually the SetCookies property of the IronWASP Response object.</description>
</parameter>
</parameters>
<return>None</return>
<description>Sets the Cookie of the request with the provided value.</description>
</method>
<method>
<name>SetCookie(SetCookie SetCookieObject)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>SetCookie</datatype>
<name>SetCookieObject</name>
<description>A SetCookie object</description>
</parameter>
</parameters>
<return>None</return>
<description>Sets the Cookie of the request with the provided value.</description>
</method>
<method>
<name>SetCookie(CookieStore Store)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>CookieStore</datatype>
<name>Store</name>
<description>CookieStore object where cookies are stored</description>
</parameter>
</parameters>
<return>None</return>
<description>Reads the CookieStore objects and the Cookies relevant to this Request are added. [i[br]]Revelant cookies are picked based on the Host, Path and Secure attributes of the cookies stored in the CookieStore.</description>
</method>
<method>
<name>GetBodyEncoding()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string</return>
<description>Returns the Encoding Charset of the request from the Content-Type header. [i[br]]If no Charset is specified then ISO-8859-1 is returned.</description>
</method>
<method>
<name>GetHeadersAsString()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string</return>
<description>Returns the entire Request header section containing the method, url, HTTP version and headers as a single string.</description>
</method>
<method>
<name>ToString()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string</return>
<description>Returns the entire Request as a single string.</description>
</method>
<method>
<name>ToBinaryString()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string</return>
<description>Returns the entire Request as a specially formatted string that preserves any binary content in the request body.</description>
</method>
<method>
<name>GetFullRequestAsByteArray()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>byte[]</return>
<description>Returns the entire Request header section containing the method, url, HTTP version and headers as a Byte Array.</description>
</method>
<method>
<name>FromProxyLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Request in the Proxy Log.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the specified record in the Proxy Log and returns it.</description>
</method>
<method>
<name>FromProxyLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Request[]</return>
<description>Creates an array of all Request objects from the Proxy Log and returns it.</description>
</method>
<method>
<name>FromTestLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Request in the Manual Testing Log.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the specified record in the Manual Testing Log and returns it.</description>
</method>
<method>
<name>FromTestLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Request[]</return>
<description>Creates an array of all Request objects from the Manual Testing Log and returns it.</description>
</method>
<method>
<name>FromProbeLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Request in the Probe Log.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the specified record in the Probe Log (Crawler) and returns it.</description>
</method>
<method>
<name>FromProbeLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Request[]</return>
<description>Creates an array of all Request objects from the Probe Log(Crawler) and returns it.</description>
</method>
<method>
<name>FromShellLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Request in the Scripting Shell Log.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the specified record in the Scripting Shell Log and returns it.</description>
</method>
<method>
<name>FromShellLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Request[]</return>
<description>Creates an array of all Request objects from the Scripting Shell Log and returns it.</description>
</method>
<method>
<name>FromScanLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Request in the 'Automated Scanning' Log.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the specified record in the 'Automated Scanning' Log and returns it.</description>
</method>
<method>
<name>FromScanLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Request[]</return>
<description>Creates an array of all Request objects from the 'Automated Scanning' Log and returns it.</description>
</method>
<method>
<name>FromString(string RequestString)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>RequestString</name>
<description>String representing the entire request, usually the output of the ToString() method.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the string and returns it.</description>
</method>
<method>
<name>FromBinaryString(string RequestBinaryString)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>RequestString</name>
<description>Specially formatted binary string representing the entire request, the output of the ToBinaryString() method.</description>
</parameter>
</parameters>
<return>Request</return>
<description>Creates a Request object from the string and returns it.</description>
</method>
<method>
<name>GetId()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>int</return>
<description>Returns the ID of the Request object in its respective log.</description>
</method>
</methods>
</class>
<class>
<name>Response</name>
<type>Non-Static</type>
<description>Object that represents a HTTP response. Has methods to read and analyze the response.</description>
<constructors>
</constructors>
<properties>
<property>
<name>Code</name>
<datatype>int</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Status code of the response. [i[br]]Eg: 200</description>
</property>
<property>
<name>Status</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Status description of the response. [i[br]]Eg: OK</description>
</property>
<property>
<name>HttpVersion</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] HTTP Version of the response.[i[br]]Eg: HTTP/1.1</description>
</property>
<property>
<name>SetCookies</name>
<datatype>SetCookie[]</datatype>
<type>Non-Static</type>
<description>A collection of SetCookie objects. This is built by parsing the 'Set-Cookie' headers in the Response</description>
</property>
<property>
<name>Headers</name>
<datatype>Parameters</datatype>
<type>Non-Static</type>
<description>Contains the Request Headers in a list of Key/Value pairs. [i[br]]Access these parameters using the methods of the Parameter Class</description>
</property>
<property>
<name>IsBinary</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Response is in text or binary format. [i[br]] This property can be controlled by setting a suitable value in the HTTP API section of the config panel</description>
</property>
<property>
<name>HasBody</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value representing the presence of a Body in the Response.</description>
</property>
<property>
<name>BodyString</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Body of the response represented as a string.</description>
</property>
<property>
<name>BinaryBodyString</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Body of the response represented as a Base64 encoded string.</description>
</property>
<property>
<name>BodyArray</name>
<datatype>byte[]</datatype>
<type>Non-Static</type>
<description>Body of the response represented as a Byte Array.</description>
</property>
<property>
<name>BodyEncoding</name>
<datatype>string</datatype>
<type>Non-Static</type>
<description>Content Encoding used for the Response Body.</description>
</property>
<property>
<name>Html</name>
<datatype>HTML</datatype>
<type>Non-Static</type>
<description>Body of the Response represented as a HTML object.</description>
</property>
<property>
<name>IsHtml</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Response is HTML text or not.</description>
</property>
<property>
<name>IsJavaScript</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Response is valid JavaScript text or not.</description>
</property>
<property>
<name>IsCss</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Response is valid CSS text or not.</description>
</property>
<property>
<name>IsXml</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Response is valid XML text or not.</description>
</property>
<property>
<name>IsJson</name>
<datatype>bool</datatype>
<type>Non-Static</type>
<description>[READ-ONLY] Boolean value indicating if the Body of the Response is valid JSON text or not.</description>
</property>
</properties>
<methods>
<method>
<name>ToString()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string</return>
<description>Returns the entire Response as a single string.</description>
</method>
</methods>
</class>
<class>
<name>Session</name>
<type>Non-Static</type>
<description>Represents an HTTP transaction, contains a Request and a Response object.</description>
<constructors>
</constructors>
<properties>
<property>
<name>Request</name>
<datatype>Request</datatype>
<type>Non-Static</type>
<description>The Request object stored inside the Session.</description>
</property>
<property>
<name>Response</name>
<datatype>Response</datatype>
<type>Non-Static</type>
<description>The Response corresponding to the Request object, if available.</description>
</property>
</properties>
<methods>
<method>
<name>FromProxyLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Session in the Proxy Log.</description>
</parameter>
</parameters>
<return>Session</return>
<description>Creates an Session object from the specified record in the Proxy Log and returns it.</description>
</method>
<method>
<name>FromProxyLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Session[]</return>
<description>Creates an array of all Session objects from the Proxy Log and returns it.</description>
</method>
<method>
<name>FromTestLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Session in the Manual Testing Log.</description>
</parameter>
</parameters>
<return>Session</return>
<description>Creates an Session object from the specified record in the Manual Testing Log and returns it.</description>
</method>
<method>
<name>FromTestLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Session[]</return>
<description>Creates an array of all Session objects from the Manual Testing Log and returns it.</description>
</method>
<method>
<name>FromProbeLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Session in the Probe Log.</description>
</parameter>
</parameters>
<return>Session</return>
<description>Creates an Session object from the specified record in the Probe Log(Crawler) and returns it.</description>
</method>
<method>
<name>FromProbeLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Session[]</return>
<description>Creates an array of all Session objects from the Probe Log(Crawler) and returns it.</description>
</method>
<method>
<name>FromShellLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Session in the Scripting Shell Log.</description>
</parameter>
</parameters>
<return>Session</return>
<description>Creates an Session object from the specified record in the Scripting Shell Log and returns it.</description>
</method>
<method>
<name>FromShellLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Session[]</return>
<description>Creates an array of all Session objects from the Scripting Shell Log and returns it.</description>
</method>
<method>
<name>FromScanLog(int ID)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>int</datatype>
<name>ID</name>
<description>ID of the Session in the 'Automated Scanning' Log.</description>
</parameter>
</parameters>
<return>Session</return>
<description>Creates an Session object from the specified record in the 'Automated Scanning' Log and returns it.</description>
</method>
<method>
<name>FromScanLog()</name>
<type>Static</type>
<parameters></parameters>
<return>Session[]</return>
<description>Creates an array of all Session objects from the 'Automated Scanning' Log and returns it.</description>
</method>
<method>
<name>GetId()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>int</return>
<description>Returns the ID of the Session object in its respective log.</description>
</method>
</methods>
</class>
<class>
<name>Parameters</name>
<type>Non-Static</type>
<description>Base class for the QueryParameters, BodyParameters, HeaderParameters and CookieParameter classes. Used to store Key-Value pairs. Key is a string and Value is a list of strings.[i[br]] The Keys for HeaderParameters are case-insensitive, for others it is case-sensitive.</description>
<constructors>
</constructors>
<properties>
<property>
<name>Count</name>
<datatype>int</datatype>
<type>Non-Static</type>
<description>Number of Parameters present in this object.</description>
</property>
</properties>
<methods>
<method>
<name>Get(string Name)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
</parameters>
<return>string</return>
<description>Returns the value of the parameter with the given name in the same decoded form as the application would see it. [i[br]]For example in the Url 'http://example.org/a?q=a%23b' the value of Query parameter 'q' will be returned as 'a#b' by the Get method as it will properly decode it before returning.</description>
</method>
<method>
<name>RawGet(string Name)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
</parameters>
<return>string</return>
<description>Returns the raw value of the parameter with the given name, as it appears in the HTTP Request string that is sent over the network. [i[br]]Depending on if this is Query/Body/Header/Cookie parameter the value will be the appropriate encoded form.[i[br]]For example in the Url 'http://example.org/a?q=a%23b' the value of Query parameter 'q' will be returned as 'a%23b' by RawGet method, whereas the Get method would decode it and return as 'a#b'.</description>
</method>
<method>
<name>GetNames()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string[]</return>
<description>Returns the Names of all the parameters as a list. The form of parameter names is the same decoded form as the application would see it.[i[br]]For example in the Url 'http://example.org/a?q%23r=ab' the value of Query parameter name will be returned as 'q#r' by GetNames method.</description>
</method>
<method>
<name>RawGetNames()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string[]</return>
<description>Returns the Names of all the parameters as a list. The form of the parameter names is as it appears in the HTTP Request string that is sent over the network. [i[br]]Depending on if this is Query/Body/Header/Cookie parameter name the value will be the appropriate encoded form.[i[br]]For example in the Url 'http://example.org/a?q%23r=ab' the value of Query parameter name will be returned as 'q%23r' by RawGetNames method, whereas the GetNames method would decode it and return as 'q#r'.</description>
</method>
<method>
<name>GetAll(string Name)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
</parameters>
<return>string[]</return>
<description>Returns all values of the parameters with the given name. The form of the parameter values is the same decoded form as the application would see it(Refer Get for example). [i[br]]Used when there are two or more parameters with the same name.</description>
</method>
<method>
<name>RawGetAll(string Name)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
</parameters>
<return>string[]</return>
<description>Returns all values of the parameters with the given name. The form of the parameter values is as they appear in the HTTP Request string that is sent over the network (Refer RawGet for example).[i[br]]Used when there are two or more parameters with the same name.</description>
</method>
<method>
<name>Set(string Name, string Value)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>Value</name>
<description>Value of the parameter in the decoded form you want the application to see it. [i[br]]Eg: If Set('q', 'a+b') is called on Query parameter of a Request then the in the Url it would become '?q=a%2bb' and so the value of q will be read by the application as 'a+b', as originally set.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list. [i[br]] If a parameter with that name exisits then it is overwritten.</description>
</method>
<method>
<name>RawSet(string Name, string Value)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>Value</name>
<description>Value of the parameter in the encoded form as it appears in the HTTP Request string that is sent over the network. [i[br]]Eg: If RawSet('q', 'a+b') is called on Query parameter of a Request then in the Url it would become '?q=a+b' and so the value of q will be read by the application as 'a b'.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list. [i[br]] If a parameter with that name exisits then it is overwritten.</description>
</method>
<method>
<name>Set(string Name, int SubParameterPosition, string Value)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>int</datatype>
<name>SubParameterPosition</name>
<description>When there are two or more parameters with the same name then this indicates the zero-based index of the parameter position that must be set</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>Value</name>
<description>Value of the parameter in the decoded form you want the application to see it.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list at a specified position if two or more parameters exist with the same name. [i[br]] If a parameter with that name exisits then it is overwritten.</description>
</method>
<method>
<name>RawSet(string Name, int SubParameterPosition, string Value)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>int</datatype>
<name>SubParameterPosition</name>
<description>When there are two or more parameters with the same name then this indicates the zero-based index of the parameter position that must be set</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>Value</name>
<description>Value of the parameter in the encoded form as it appears in the HTTP Request string that is sent over the network.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list at a specified position if two or more parameters exist with the same name. [i[br]] If a parameter with that name exisits then it is overwritten.</description>
</method>
<method>
<name>Set(string Name, string[] Values)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>string[]</datatype>
<name>Values</name>
<description>Array of multiple values for the same parameter. The values are in the decoded form you want the application to see it.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list. [i[br]] If a parameter with that name exisits then it is overwritten.</description>
</method>
<method>
<name>RawSet(string Name, string[] Values)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>string[]</datatype>
<name>Values</name>
<description>Array of multiple values for the same parameter. The values of the parameter in the encoded form as it appears in the HTTP Request string that is sent over the network.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list. [i[br]] If a parameter with that name exisits then it is overwritten.</description>
</method>
<method>
<name>Add(string Name, string Value)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>Value</name>
<description>Value of the parameter in the decoded form you want the application to see it. [i[br]]Eg: If Add('q', 'a+b') is called on Query parameter of a Request then the in the Url it would become '?q=a%2bb' and so the value of q will be read by the application as 'a+b', as originally set.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list. [i[br]]If a parameter with that name exisits then this value is appened to the exisiting list.</description>
</method>
<method>
<name>RawAdd(string Name, string Value)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
<parameter>
<datatype>string</datatype>
<name>Value</name>
<description>Value of the parameter in the encoded form as it appears in the HTTP Request string that is sent over the network. [i[br]]Eg: If RawAdd('q', 'a+b') is called on Query parameter of a Request then in the Url it would become '?q=a+b' and so the value of q will be read by the application as 'a b'.</description>
</parameter>
</parameters>
<return>Void</return>
<description>Adds the Name/Value pair to the parameters list. [i[br]]If a parameter with that name exisits then this value is appened to the exisiting list.</description>
</method>
<method>
<name>Remove(string Name)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
</parameters>
<return>Void</return>
<description>Removes the specified parameter from the list.</description>
</method>
<method>
<name>RemoveAll()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>Void</return>
<description>Removes all parameters from the list.</description>
</method>
<method>
<name>Has(string Name)</name>
<type>Non-Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Name</name>
<description>Name of the parameter</description>
</parameter>
</parameters>
<return>Bool</return>
<description>Checks if the given parameter name exists in the list and returns a bool value.</description>
</method>
<method>
<name>GetMultis()</name>
<type>Non-Static</type>
<parameters></parameters>
<return>string[]</return>
<description>Returns the name of the parameters that have multiple values. [i[br]]Use GetAll to get those values.</description>
</method>
</methods>
</class>
<class>
<name>Tools</name>
<type>Static</type>
<description>Collection of commonly required utilities</description>
<constructors>
</constructors>
<properties>
</properties>
<methods>
<method>
<name>UrlEncode(string Input)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Input</name>
<description>String to encode</description>
</parameter>
</parameters>
<return>string</return>
<description>Returns a Url-Encoded version of the input.</description>
</method>
<method>
<name>HtmlEncode(string Input)</name>
<type>Static</type>
<parameters>
<parameter>
<datatype>string</datatype>
<name>Input</name>
<description>String to encode</description>
</parameter>
</parameters>
<return>string</return>
<description>Returns a HTML-encoded version of the input.</description>