diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-13 12:12:22 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-13 12:12:22 +0200 |
| commit | 5abf00ab87a55662eefc7716de52ead9749293c6 (patch) | |
| tree | 1cfa64b99482d7cc08b1d7da5d6833b75f5f7714 /docs/src/api/go/functions.md | |
| parent | 57d6c2ac55a5fd1ea609c873d5410174b7cf6ca4 (diff) | |
Refactor: Adapt the API to the documentation
Diffstat (limited to 'docs/src/api/go/functions.md')
| -rw-r--r-- | docs/src/api/go/functions.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/src/api/go/functions.md b/docs/src/api/go/functions.md index c647787..381f5be 100644 --- a/docs/src/api/go/functions.md +++ b/docs/src/api/go/functions.md @@ -26,9 +26,10 @@ Returns a string of JSON data with the servers/organizations and an `error`, nil ## OpenVPN/Wireguard config See [Overview](../overview/getconfig.html) ```go -func GetConnectConfig(url string, forceTCP bool) (string, string, error) +func GetConfigInstituteAccess(url string, forceTCP bool) (string, string, error) +func GetConfigSecureInternet(url string, forceTCP bool) (string, string, error) ``` -- `url`: The url of the server to get a connect config for +- `url`: The URL of the Institute Access or Secure Internet server to get a connect config for - `forceTCP`: Whether or not we want to force enable TCP Returns: @@ -36,6 +37,12 @@ Returns: - A `string`, `openvpn` or `wireguard` indicating if it is an OpenVPN or Wireguard config - An `error` (can be nil) +### Cancelling OAuth +```go +func CancelOAuth() error +``` +Returns an `error`, can be nil indicating no error + ### Setting a profile ID ```go func SetProfileID(profileID string) error |
