RomanNum3ral
/
AutoRecon
mirror of https://github.com/Tib3rius/AutoRecon.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated API Documentation (markdown)

Tib3rius 2022-06-12 00:13:24 -04:00
parent 069e2e9292
commit 8063fab924
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
API-Documentation.md

@ -252,7 +252,19 @@ Resulting Value: baz2 (string)
***
#### get_option(name)
The `get_option` method is used to retrieve the value of an option (either set by the user or the default) that the plugin has previously configured. The `name` argument should be the same value as the `name` argument of the original option.
#### get_option(name, default=None)
The `get_option` method is used to retrieve the value of an option (either set by the user or the default) that the plugin has previously configured. The `name` argument should be the same value as the `name` argument of the original option. In the event that an option was defined without a default value, the optional `default` argument can be set to a default value of your choice.
This method should only be used in the run() coroutine of a plugin.
This method should only be used in the run() coroutine of a plugin.
***
#### get_global_option(name, default=None)
The `get_global_option` method is used to retrieve the value of a global option (either set by the user or the default). The `name` argument should be the same value as the `name` argument of the global option. The optional `default` argument can be set to a default value of your choice.
This method can be used in the run() coroutine and the manual() method of a plugin.
***
#### get_global(name, default=None)
The `get_global_option` method is an alias for the `get_global_option` method.