Documentation

[thomaswardiii]

There's a drastic lack of documentation for this entire library. An example is provided, but no alternatives showing any other useful codeflows are shown.

What's the setup for an Authorization codeflow and how does it differ from a Device codeflow?
How do you use the TokenCaching?
What do you do when the API doesn't respond or properly authenticate?

None of this is explained anywhere. There are many pieces not explained. Just the internal data structures, and not the internal classes

[issork]

Hello, I appreciate your feedback.

I do not plan on providing a documentation beyond the example, which focuses on the Godot-specific implementation. For everything else - like the difference between the device and authorization flow, a documentation would be indifferent from Twitch's official one, which can be found here -> https://dev.twitch.tv/docs/

How do you use the TokenCaching?

The token caching is still work in progress. I unfortunately do not have the time or motivation for more frequent updates, primarily due to my own games development, but also because I stopped using everything Amazon-related a few years ago, which includes Twitch. Ultimately, the Token cache will be able to reuse an old token, as long as it is still valid. Invalid tokens will be automatically refreshed, as long as a refresh token is present (which is not granted by all flows).

What do you do when the API doesn't respond or properly authenticate?

In this regard, the example really is lacking. There are signals for those cases, but they are not used within the example - which I will change in a future update.

Thanks!