-
Notifications
You must be signed in to change notification settings - Fork 247
Create class GIDUserAuth #177
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Add class GIDUserAuth to represent the outcome of a successful signIn or addScopes flow.
| /// An OAuth2 authorization code for the home server. | ||
| @property(nonatomic, readonly, nullable) NSString *serverAuthCode; | ||
|
|
||
| + (instancetype)new NS_UNAVAILABLE; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth documenting here how this type is supposed to be created?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we don't need to document that. For our clients they only need to read the data inside this class. I will add unsupported here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think /// Unsupported. adds much. It'd be more helpful to have something like (for this and init below):
Unavailable. See the internally scoped -[GIDUserAuth_Private initWithGoogleUser:serverAuthCode:] to create an instance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a public API. There is no benefit if we tell them how to create this instance because we don't want them to do it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough. I don't think /// Unsupported. is useful. Feel free to remove.
* Create class GIDUserAuth Add class GIDUserAuth to represent the outcome of a successful signIn or addScopes flow.
* Create class GIDUserAuth Add class GIDUserAuth to represent the outcome of a successful signIn or addScopes flow.
Add class GIDUserAuth to represent the outcome of a successful signIn or addScopes flow.