diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-09-19 12:45:53 +0200 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2023-09-25 09:43:37 +0200 |
| commit | 627e787809c94e38b9f14f3b9d095187a5a8a849 (patch) | |
| tree | 09fa3490543a9ee185628522d6cc8ac69f0144a7 /docs/src | |
| parent | d4c60c8a0c566cf9f605a3b3e431ea8b51d1d4c8 (diff) | |
Export Docs: Update bullets spacing
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/api/functiondocs.md | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/docs/src/api/functiondocs.md b/docs/src/api/functiondocs.md index a9ab894..36bf30b 100644 --- a/docs/src/api/functiondocs.md +++ b/docs/src/api/functiondocs.md @@ -126,6 +126,7 @@ This value should not be parsed or converted somehow by the client This value is simply to pass back to the Go library This value has two purposes: - Cancel a long running function + - Send a reply to a state transition (ASK_PROFILE and ASK_LOCATION) Functions that take a cookie have it as the first argument @@ -141,6 +142,7 @@ The data that is sent to the Go library is the second argument of this function - `c` is the Cookie + - `data` is the data to send, e.g. a profile ID ## CurrentServer @@ -279,9 +281,13 @@ CookieReply So a client would: -- Parse the data to get the cookie and data - get the cookie, - get the -profiles from the data - show it in the UI and then reply with CookieReply -using the choice +- Parse the data to get the cookie and data + +- get the cookie, + +- get the profiles from the data + +- show it in the UI and then reply with CookieReply using the choice ### ASK_LOCATION @@ -303,8 +309,11 @@ CookieReply, So a client would: - Parse the data to get the cookie and data + - get the cookie, + - get the list of locations from the data + - show it in the UI and then reply with CookieReply using the choice ### OAUTH_STARTED @@ -344,14 +353,18 @@ user agent in all HTTP requests `cb` is the state callback. It takes three arguments: The old state, the new state and the data for the state as JSON + - Note that the states are defined in client/fsm.go, e.g. NO_SERVER (in Go: StateNoServer), ASK_PROFILE (in Go: StateAskProfile) + - This callback returns non-zero if the state transition is handled. This is used to check if the client handles the needed transitions debug, if non-zero, enables debugging mode for the library, this means: + - Log everything in debug mode, so you can get more detail of what is going on + - Write the state graph to a file in the configDirectory. This can be used to create a FSM png file with mermaid https://mermaid.js.org/ @@ -490,6 +503,7 @@ setter is the void function that sets tokens. It takes two arguments: - The `server` for which to get the tokens for, marshalled as JSON and defined in types/server/server.go `Current` + - The `tokens`, defined in types/server/server.go `Tokens` marshalled as JSON |
