AWSSignInProvider Protocol Reference
| Conforms to | AWSIdentityProvider |
|---|---|
| Declared in | AWSSignInProvider.h |
Overview
AWSSignInProvider protocol defines a list of methods and properties which a Sign-In Provider should implement.
The AWSSignInProvider is implemented by difference Sign-In Providers like FacbookSignInProvider, GoogleSignInProvider, etc.
loggedIn
required method
Determines if a user is logged in.
@property (nonatomic, readonly, getter=isLoggedIn) BOOL loggedInDeclared In
AWSSignInProvider.h
imageURL
required method
The URL for profile image of a user.
@property (nonatomic, readonly, nullable) NSURL *imageURLDeclared In
AWSSignInProvider.h
userName
required method
The User Name of a user.
@property (nonatomic, readonly, nullable) NSString *userNameDeclared In
AWSSignInProvider.h
– login:
required method
The login handler method for the Sign-In Provider. The completionHandler will bubble back errors to the developers.
- (void)login:(void ( ^ ) ( id _Nullable result , NSError *_Nullable error ))completionHandlerDeclared In
AWSSignInProvider.h
– logout
required method
The logout handler method for the Sign-In Provider.
- (void)logoutDeclared In
AWSSignInProvider.h
– setCachedLoginFlag
required method
Call this method on a successful login. This method should store a flag in persistent storage which determines if the user has signed-in using this sign-in provider.
This method is called by AWSIdentityManager on interceptApplication:didFinishLaunchingWithOptions method to set the current sign-in provider.
- (void)setCachedLoginFlagDeclared In
AWSSignInProvider.h
– clearCachedLoginFlag
required method
Clears the cached login flag. This method should be called during logout to clear the stored flag.
- (void)clearCachedLoginFlagDeclared In
AWSSignInProvider.h
– isCachedLoginFlagSet
required method
Fetches the status of the cached login flag set using setCachedLoginFlag.
- (BOOL)isCachedLoginFlagSetReturn Value
YES if the setCachedLoginFlag is set.
Declared In
AWSSignInProvider.h
– reloadSession
required method
The handler method for managing the session reload for the Sign-In Provider.
- (void)reloadSessionDeclared In
AWSSignInProvider.h