Adds Shutdown. Moved docs to interfaces. #67
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Adds a Shutdown option to the auth state notification. This provides a mechanism to manually terminate the background refresh thread without logging out. This allows the client to be used cleanly when running in the Unity editor.
In addition, went ahead and moved the docs to the interfaces and inherit docs on the implementation - less copy and paste FTW.
What is the current behavior?
Only user visible / API change is the addition of the Shutdown auth state. It's possible that if client code is throwing an exception on an unexpected state change they might get an exception here. This is the kind of thing that IDEs like Rider are pretty good at catching in static code analysis FWIW.
Oh, and now the docs should be visible for IDEs when working with both the interfaces and the implementation code.