Skip to content

Commit 0cb0ac1

Browse files
committed
Update README.md
1 parent 5854119 commit 0cb0ac1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,20 @@ The wrapper also contains an overloaded Analyze method which only requires the h
4747
public Analyze Analyze(string host)
4848
```
4949

50+
##### AutomaticAnalyze()
51+
52+
The Analyze method is used to initiate and wait for an assessment to complete before retrieving results. Compared to the normal Analyze() method this method keeps checking the Api and only when a scan has finished does it return. This saves the comsumer from having to write their own logic for handling an assessment in progress.
53+
Another call to GetEndpointDetails() may be needed to view the whole result set for a given endpoint.
54+
55+
```C#
56+
public Analyze AutomaticAnalyze(string host, Publish publish, ClearCache clearCache, FromCache fromCache, All all)
57+
```
58+
59+
The wrapper also contains an overloaded AutomaticAnalyze method which only requires the host parameter. Internal is uses the following parameter options - Publish.Off, ClearCache.On, FromCache.Ignore, All.On.
60+
```C#
61+
public Analyze AutomaticAnalyze(string host)
62+
```
63+
5064
##### GetEndpointData()
5165

5266
The GetEndpointData method is used to retrieve a fully results set.

0 commit comments

Comments
 (0)