diff --git a/RxFireAuth.podspec b/RxFireAuth.podspec index 6d10059..10c35e3 100644 --- a/RxFireAuth.podspec +++ b/RxFireAuth.podspec @@ -8,7 +8,7 @@ Pod::Spec.new do |s| s.name = 'RxFireAuth' - s.version = '1.1.0' + s.version = '1.2.0' s.summary = 'A smart Rx wrapper around Firebase Authentication SDK' # This description is used to generate tags and improve search results. diff --git a/docs/Classes.html b/docs/Classes.html index 011f0ae..98b07b2 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -14,7 +14,7 @@
-

RxFireAuth Docs (95% documented)

+

RxFireAuth Docs (96% documented)

diff --git a/docs/Classes/SignInWithAppleHandler.html b/docs/Classes/SignInWithAppleHandler.html index 82e79ca..29fb160 100644 --- a/docs/Classes/SignInWithAppleHandler.html +++ b/docs/Classes/SignInWithAppleHandler.html @@ -14,7 +14,7 @@
-

RxFireAuth Docs (95% documented)

+

RxFireAuth Docs (96% documented)

diff --git a/docs/Classes/UserManager.html b/docs/Classes/UserManager.html index f3d4206..a18134e 100644 --- a/docs/Classes/UserManager.html +++ b/docs/Classes/UserManager.html @@ -14,7 +14,7 @@
-

RxFireAuth Docs (95% documented)

+

RxFireAuth Docs (96% documented)

@@ -179,6 +179,32 @@

Declaration

+
  • +
    + + + + isAnonymous + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isAnonymous: Bool { get }
    + +
    +
    +
    +
    +
  • diff --git a/docs/Enums.html b/docs/Enums.html index 6d7b52d..f6e32a8 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/Enums/UserError.html b/docs/Enums/UserError.html index 53870c3..6afc469 100644 --- a/docs/Enums/UserError.html +++ b/docs/Enums/UserError.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -235,9 +235,9 @@

    Declaration

  • - - - errorDescription + + + alreadyAnonymous
    @@ -245,13 +245,338 @@

    Declaration

    - +

    The requested action cannot be performed because there is already an anonymous user logged-in.

    +

    Declaration

    Swift

    - 
    public var errorDescription: String? { get }
    + 
    case alreadyAnonymous
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userNotFound + +
    +
    +
    +
    +
    +
    +

    The specified user cannot be found.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case userNotFound
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userDisabled + +
    +
    +
    +
    +
    +
    +

    The specified user is disabled.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case userDisabled
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expiredToken + +
    +
    +
    +
    +
    +
    +

    The user token has expired.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expiredToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wrongPassword + +
    +
    +
    +
    +
    +
    +

    The specified password is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wrongPassword
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalidCredential + +
    +
    +
    +
    +
    +
    +

    The specified credential is either expired or invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidCredential
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + emailAlreadyInUse + +
    +
    +
    +
    +
    +
    +

    The specified email is already in use in another account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case emailAlreadyInUse
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + weakPassword(_:) + +
    +
    +
    +
    +
    +
    +

    The specified password does not satisfy the basic security requirements.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case weakPassword(String?)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wrongUser + +
    +
    +
    +
    +
    +
    +

    The requested action would target a different user than the one currently signed-in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wrongUser
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + authenticationConfirmationRequired + +
    +
    +
    +
    +
    +
    +

    The requested action requires a recent call to self.confirmAuthentication(email:password:).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authenticationConfirmationRequired
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + providerAlreadyLinked + +
    +
    +
    +
    +
    +
    +

    The specified provider is already linked with this user.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case providerAlreadyLinked
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + networkError + +
    +
    +
    +
    +
    +
    +

    An error occurred while reaching Firebase servers.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case networkError
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + configurationError + +
    +
    +
    +
    +
    +
    +

    The requested operation is not enabled in Firebase Console.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case configurationError
    @@ -261,9 +586,90 @@

    Declaration

  • +
    +
    +
    +
    +
    +

    The provided Firebase configuration is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidConfiguration
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + keychainError(_:) + +
    +
    +
    +
    +
    +
    +

    An error occurred while attempting to access the keychain.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case keychainError(Error?)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unknown(_:) + +
    +
    +
    +
    +
    +
    +

    An unknown error has occurred.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown(Error?)
    + +
    +
    +
    +
    +
    • +
  • +
    @@ -277,7 +683,7 @@

    Declaration

    Declaration

    Swift

    - 
    public var failureReason: String? { get }
    + 
    public var errorDescription: String? { get }
    diff --git a/docs/Protocols.html b/docs/Protocols.html index 86c5caf..98287d6 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -141,6 +141,9 @@

    Declaration

    reference this protocol instead of the default implementation UserManager, as this protocol will always conform to Semantic Versioning.

    +

    All methods of this protocol are wrapped inside a Rx object that +will not execute any code until somebody subscribes to it.

    + See more
    diff --git a/docs/Protocols/LoginProviderManagerType.html b/docs/Protocols/LoginProviderManagerType.html index b842067..d06e243 100644 --- a/docs/Protocols/LoginProviderManagerType.html +++ b/docs/Protocols/LoginProviderManagerType.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/Protocols/UserManagerType.html b/docs/Protocols/UserManagerType.html index 9972803..bd182c5 100644 --- a/docs/Protocols/UserManagerType.html +++ b/docs/Protocols/UserManagerType.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -95,6 +95,9 @@

    UserManagerType

    reference this protocol instead of the default implementation UserManager, as this protocol will always conform to Semantic Versioning.

    +

    All methods of this protocol are wrapped inside a Rx object that +will not execute any code until somebody subscribes to it.

    +
    • @@ -126,6 +129,33 @@

    Declaration

    • +
  • +
    + + + + isAnonymous + +
    +
    +
    +
    +
    +
    +

    Get if there is an anonymous user logged-in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    var isAnonymous: Bool { get }
    + +
    +
    +
    +
    +
  • @@ -562,6 +592,13 @@

    Return Value

    Logout the currently logged-in user.

    +

    Using the resetToAnonymous parameter, you can make sure +that there is always a user signed in.

    +
    +

    Throws

    + +
    +

    Declaration

    @@ -583,7 +620,7 @@

    Parameters

    -

    If true, after having logged-out successfully, this function will immediately sign in a new anonymous user.

    +

    If true, after having logged-out successfully, this function will immediately sign in a new anonymous user.

    diff --git a/docs/Structs.html b/docs/Structs.html index 87ae0d2..42be4c3 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/Structs/LoginDescriptor.html b/docs/Structs/LoginDescriptor.html index d5b7f13..22fa96d 100644 --- a/docs/Structs/LoginDescriptor.html +++ b/docs/Structs/LoginDescriptor.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/Structs/UserData.html b/docs/Structs/UserData.html index 364f598..106f4d4 100644 --- a/docs/Structs/UserData.html +++ b/docs/Structs/UserData.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/Typealiases.html b/docs/Typealiases.html index f569b50..bb2d1c7 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/badge.svg b/docs/badge.svg index 19d671e..7c971c6 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -19,10 +19,10 @@ documentation - 95% + 96% - 95% + 96% diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes.html index 011f0ae..98b07b2 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/SignInWithAppleHandler.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/SignInWithAppleHandler.html index 82e79ca..29fb160 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/SignInWithAppleHandler.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/SignInWithAppleHandler.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/UserManager.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/UserManager.html index f3d4206..a18134e 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/UserManager.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Classes/UserManager.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -179,6 +179,32 @@

    Declaration

    • +
  • +
    + + + + isAnonymous + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isAnonymous: Bool { get }
    + +
    +
    +
    +
    +
  • diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums.html index 6d7b52d..f6e32a8 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums/UserError.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums/UserError.html index 53870c3..6afc469 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums/UserError.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Enums/UserError.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -235,9 +235,9 @@

    Declaration

  • @@ -245,13 +245,338 @@

    Declaration

    - +

    The requested action cannot be performed because there is already an anonymous user logged-in.

    +

    Declaration

    Swift

    - 
    public var errorDescription: String? { get }
    + 
    case alreadyAnonymous
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userNotFound + +
    +
    +
    +
    +
    +
    +

    The specified user cannot be found.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case userNotFound
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + userDisabled + +
    +
    +
    +
    +
    +
    +

    The specified user is disabled.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case userDisabled
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expiredToken + +
    +
    +
    +
    +
    +
    +

    The user token has expired.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expiredToken
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wrongPassword + +
    +
    +
    +
    +
    +
    +

    The specified password is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wrongPassword
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + invalidCredential + +
    +
    +
    +
    +
    +
    +

    The specified credential is either expired or invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidCredential
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + emailAlreadyInUse + +
    +
    +
    +
    +
    +
    +

    The specified email is already in use in another account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case emailAlreadyInUse
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + weakPassword(_:) + +
    +
    +
    +
    +
    +
    +

    The specified password does not satisfy the basic security requirements.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case weakPassword(String?)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + wrongUser + +
    +
    +
    +
    +
    +
    +

    The requested action would target a different user than the one currently signed-in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case wrongUser
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The requested action requires a recent call to self.confirmAuthentication(email:password:).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authenticationConfirmationRequired
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + providerAlreadyLinked + +
    +
    +
    +
    +
    +
    +

    The specified provider is already linked with this user.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case providerAlreadyLinked
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + networkError + +
    +
    +
    +
    +
    +
    +

    An error occurred while reaching Firebase servers.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case networkError
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + configurationError + +
    +
    +
    +
    +
    +
    +

    The requested operation is not enabled in Firebase Console.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case configurationError
    @@ -261,9 +586,90 @@

    Declaration

  • +
    +
    +
    +
    +
    +

    The provided Firebase configuration is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case invalidConfiguration
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + keychainError(_:) + +
    +
    +
    +
    +
    +
    +

    An error occurred while attempting to access the keychain.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case keychainError(Error?)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + unknown(_:) + +
    +
    +
    +
    +
    +
    +

    An unknown error has occurred.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown(Error?)
    + +
    +
    +
    +
    +
    • +
  • +
    @@ -277,7 +683,7 @@

    Declaration

    Declaration

    Swift

    - 
    public var failureReason: String? { get }
    + 
    public var errorDescription: String? { get }
    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols.html index 86c5caf..98287d6 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -141,6 +141,9 @@

    Declaration

    reference this protocol instead of the default implementation UserManager, as this protocol will always conform to Semantic Versioning.

    +

    All methods of this protocol are wrapped inside a Rx object that +will not execute any code until somebody subscribes to it.

    + See more
    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/LoginProviderManagerType.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/LoginProviderManagerType.html index b842067..d06e243 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/LoginProviderManagerType.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/LoginProviderManagerType.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/UserManagerType.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/UserManagerType.html index 9972803..bd182c5 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/UserManagerType.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Protocols/UserManagerType.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    @@ -95,6 +95,9 @@

    UserManagerType

    reference this protocol instead of the default implementation UserManager, as this protocol will always conform to Semantic Versioning.

    +

    All methods of this protocol are wrapped inside a Rx object that +will not execute any code until somebody subscribes to it.

    +
    • @@ -126,6 +129,33 @@

    Declaration

    • +
  • +
    + + + + isAnonymous + +
    +
    +
    +
    +
    +
    +

    Get if there is an anonymous user logged-in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    var isAnonymous: Bool { get }
    + +
    +
    +
    +
    +
  • @@ -562,6 +592,13 @@

    Return Value

    Logout the currently logged-in user.

    +

    Using the resetToAnonymous parameter, you can make sure +that there is always a user signed in.

    +
    +

    Throws

    + +
    +

    Declaration

    @@ -583,7 +620,7 @@

    Parameters

    -

    If true, after having logged-out successfully, this function will immediately sign in a new anonymous user.

    +

    If true, after having logged-out successfully, this function will immediately sign in a new anonymous user.

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs.html index 87ae0d2..42be4c3 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/LoginDescriptor.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/LoginDescriptor.html index d5b7f13..22fa96d 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/LoginDescriptor.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/LoginDescriptor.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/UserData.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/UserData.html index 364f598..106f4d4 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/UserData.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Structs/UserData.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Typealiases.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Typealiases.html index f569b50..bb2d1c7 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Typealiases.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/Typealiases.html @@ -14,7 +14,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/index.html b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/index.html index 3ce49a3..d1683c8 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/index.html @@ -13,7 +13,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/search.json b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/search.json index 1a43d57..29bdcdf 100644 --- a/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/search.json +++ b/docs/docsets/RxFireAuth.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:10RxFireAuth32SignInWithAppleCompletionHandlera":{"name":"SignInWithAppleCompletionHandler","abstract":"

    Instances of SignInWithAppleHandler need"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV2idSSSgvp":{"name":"id","abstract":"

    Get the ID.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV5emailSSSgvp":{"name":"email","abstract":"

    Get the email.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11displayNameSSSgvp":{"name":"displayName","abstract":"

    Get the user display name.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11isAnonymousSbvp":{"name":"isAnonymous","abstract":"

    Get if this is an anonymous user.

    ","parent_name":"UserData"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV8fullNameSSSgvp":{"name":"fullName","abstract":"

    Get the full user name.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV16performMigrationSbvp":{"name":"performMigration","abstract":"

    Get if this login operation requires a data migration.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9oldUserIdSSSgvp":{"name":"oldUserId","abstract":"

    Get the old user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9newUserIdSSSgvp":{"name":"newUserId","abstract":"

    Get the new user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html":{"name":"LoginDescriptor","abstract":"

    A login descriptor represents a login operation"},"Structs/UserData.html":{"name":"UserData","abstract":"

    A User.

    "},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","abstract":"

    Get if there is a currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","abstract":"

    Get the currently logged-in user or nil if no user is logged-in.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","abstract":"

    Get an Observable that emits a new item every time the logged-in user is updated.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","abstract":"

    Verify if an account exists on the server with the passed email address.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","abstract":"

    Register a new account on the server with the passed email and credentials.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","abstract":"

    Login an anonymous user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","abstract":"

    Convert an anonymous user to a normal user with an email and a password.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","abstract":"

    Login the specified user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","abstract":"

    Sign in with the passed credentials without first checking if an account","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","abstract":"

    Logout the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","abstract":"

    Update the currently logged-in user taking new values from the","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","abstract":"

    Retrieve the currently logged-in user and use the specified","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","abstract":"

    Update the email of the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","abstract":"

    Confirm the authentication of the passed credentials with the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/LoginProviderManagerType.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","abstract":"

    Sign in with Apple in the passed view controller.

    ","parent_name":"LoginProviderManagerType"},"Protocols/LoginProviderManagerType.html":{"name":"LoginProviderManagerType","abstract":"

    This protocol defines the public API of the wrapper"},"Protocols/UserManagerType.html":{"name":"UserManagerType","abstract":"

    This protocol defines the public API of the main"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO02noD0yA2CmF":{"name":"noUser","abstract":"

    There is no user associated to perform the requested action.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO13invalidUpdateyA2CmF":{"name":"invalidUpdate","abstract":"

    The update cannot be performed because of invalid data.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO15alreadyLoggedInyA2CmF":{"name":"alreadyLoggedIn","abstract":"

    There is already another user logged-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12invalidEmailyA2CmF":{"name":"invalidEmail","abstract":"

    The provided email is not valid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17migrationRequiredyA2CmF":{"name":"migrationRequired","abstract":"

    The action would require to migrate the current user data to a new account.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"UserError"},"Enums/UserError.html#/s:10Foundation14LocalizedErrorP13failureReasonSSSgvp":{"name":"failureReason","parent_name":"UserError"},"Enums/UserError.html":{"name":"UserError","abstract":"

    Errors thrown by UserManagerType implementations.

    "},"Classes/UserManager.html#/s:10RxFireAuth11UserManagerC16clearingKeychainACSb_tcfc":{"name":"init(clearingKeychain:)","abstract":"

    Instanties a new user manager.

    ","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","parent_name":"UserManager"},"Classes/SignInWithAppleHandler.html#/s:10RxFireAuth22SignInWithAppleHandlerC04signE0010completionH0yySSSg_A3Fs5Error_pSgtcSg_tF":{"name":"signIn(completionHandler:)","abstract":"

    Start the Sign in with Apple flow.

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithAuthorization:":{"name":"authorizationController(controller:didCompleteWithAuthorization:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithError:":{"name":"authorizationController(controller:didCompleteWithError:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)presentationAnchorForAuthorizationController:":{"name":"presentationAnchor(for:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html":{"name":"SignInWithAppleHandler","abstract":"

    A helper class that handles the flow of"},"Classes/UserManager.html":{"name":"UserManager","abstract":"

    The default implementation of UserManagerType.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/s:10RxFireAuth32SignInWithAppleCompletionHandlera":{"name":"SignInWithAppleCompletionHandler","abstract":"

    Instances of SignInWithAppleHandler need"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV2idSSSgvp":{"name":"id","abstract":"

    Get the ID.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV5emailSSSgvp":{"name":"email","abstract":"

    Get the email.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11displayNameSSSgvp":{"name":"displayName","abstract":"

    Get the user display name.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11isAnonymousSbvp":{"name":"isAnonymous","abstract":"

    Get if this is an anonymous user.

    ","parent_name":"UserData"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV8fullNameSSSgvp":{"name":"fullName","abstract":"

    Get the full user name.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV16performMigrationSbvp":{"name":"performMigration","abstract":"

    Get if this login operation requires a data migration.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9oldUserIdSSSgvp":{"name":"oldUserId","abstract":"

    Get the old user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9newUserIdSSSgvp":{"name":"newUserId","abstract":"

    Get the new user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html":{"name":"LoginDescriptor","abstract":"

    A login descriptor represents a login operation"},"Structs/UserData.html":{"name":"UserData","abstract":"

    A User.

    "},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","abstract":"

    Get if there is a currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP11isAnonymousSbvp":{"name":"isAnonymous","abstract":"

    Get if there is an anonymous user logged-in.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","abstract":"

    Get the currently logged-in user or nil if no user is logged-in.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","abstract":"

    Get an Observable that emits a new item every time the logged-in user is updated.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","abstract":"

    Verify if an account exists on the server with the passed email address.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","abstract":"

    Register a new account on the server with the passed email and credentials.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","abstract":"

    Login an anonymous user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","abstract":"

    Convert an anonymous user to a normal user with an email and a password.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","abstract":"

    Login the specified user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","abstract":"

    Sign in with the passed credentials without first checking if an account","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","abstract":"

    Logout the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","abstract":"

    Update the currently logged-in user taking new values from the","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","abstract":"

    Retrieve the currently logged-in user and use the specified","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","abstract":"

    Update the email of the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","abstract":"

    Confirm the authentication of the passed credentials with the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/LoginProviderManagerType.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","abstract":"

    Sign in with Apple in the passed view controller.

    ","parent_name":"LoginProviderManagerType"},"Protocols/LoginProviderManagerType.html":{"name":"LoginProviderManagerType","abstract":"

    This protocol defines the public API of the wrapper"},"Protocols/UserManagerType.html":{"name":"UserManagerType","abstract":"

    This protocol defines the public API of the main"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO02noD0yA2CmF":{"name":"noUser","abstract":"

    There is no user associated to perform the requested action.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO13invalidUpdateyA2CmF":{"name":"invalidUpdate","abstract":"

    The update cannot be performed because of invalid data.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO15alreadyLoggedInyA2CmF":{"name":"alreadyLoggedIn","abstract":"

    There is already another user logged-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12invalidEmailyA2CmF":{"name":"invalidEmail","abstract":"

    The provided email is not valid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17migrationRequiredyA2CmF":{"name":"migrationRequired","abstract":"

    The action would require to migrate the current user data to a new account.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO16alreadyAnonymousyA2CmF":{"name":"alreadyAnonymous","abstract":"

    The requested action cannot be performed because there is already an anonymous user logged-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12userNotFoundyA2CmF":{"name":"userNotFound","abstract":"

    The specified user cannot be found.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12userDisabledyA2CmF":{"name":"userDisabled","abstract":"

    The specified user is disabled.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12expiredTokenyA2CmF":{"name":"expiredToken","abstract":"

    The user token has expired.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO13wrongPasswordyA2CmF":{"name":"wrongPassword","abstract":"

    The specified password is invalid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17invalidCredentialyA2CmF":{"name":"invalidCredential","abstract":"

    The specified credential is either expired or invalid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17emailAlreadyInUseyA2CmF":{"name":"emailAlreadyInUse","abstract":"

    The specified email is already in use in another account.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12weakPasswordyACSSSgcACmF":{"name":"weakPassword(_:)","abstract":"

    The specified password does not satisfy the basic security requirements.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO05wrongD0yA2CmF":{"name":"wrongUser","abstract":"

    The requested action would target a different user than the one currently signed-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO34authenticationConfirmationRequiredyA2CmF":{"name":"authenticationConfirmationRequired","abstract":"

    The requested action requires a recent call to self.confirmAuthentication(email:password:).

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO21providerAlreadyLinkedyA2CmF":{"name":"providerAlreadyLinked","abstract":"

    The specified provider is already linked with this user.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO07networkE0yA2CmF":{"name":"networkError","abstract":"

    An error occurred while reaching Firebase servers.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO013configurationE0yA2CmF":{"name":"configurationError","abstract":"

    The requested operation is not enabled in Firebase Console.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO20invalidConfigurationyA2CmF":{"name":"invalidConfiguration","abstract":"

    The provided Firebase configuration is invalid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO08keychainE0yACs0E0_pSgcACmF":{"name":"keychainError(_:)","abstract":"

    An error occurred while attempting to access the keychain.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO7unknownyACs0E0_pSgcACmF":{"name":"unknown(_:)","abstract":"

    An unknown error has occurred.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"UserError"},"Enums/UserError.html":{"name":"UserError","abstract":"

    Errors thrown by UserManagerType implementations.

    "},"Classes/UserManager.html#/s:10RxFireAuth11UserManagerC16clearingKeychainACSb_tcfc":{"name":"init(clearingKeychain:)","abstract":"

    Instanties a new user manager.

    ","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP11isAnonymousSbvp":{"name":"isAnonymous","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","parent_name":"UserManager"},"Classes/SignInWithAppleHandler.html#/s:10RxFireAuth22SignInWithAppleHandlerC04signE0010completionH0yySSSg_A3Fs5Error_pSgtcSg_tF":{"name":"signIn(completionHandler:)","abstract":"

    Start the Sign in with Apple flow.

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithAuthorization:":{"name":"authorizationController(controller:didCompleteWithAuthorization:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithError:":{"name":"authorizationController(controller:didCompleteWithError:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)presentationAnchorForAuthorizationController:":{"name":"presentationAnchor(for:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html":{"name":"SignInWithAppleHandler","abstract":"

    A helper class that handles the flow of"},"Classes/UserManager.html":{"name":"UserManager","abstract":"

    The default implementation of UserManagerType.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file diff --git a/docs/docsets/RxFireAuth.docset/Contents/Resources/docSet.dsidx b/docs/docsets/RxFireAuth.docset/Contents/Resources/docSet.dsidx index ed7353f..1ec4b84 100644 Binary files a/docs/docsets/RxFireAuth.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/RxFireAuth.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docsets/RxFireAuth.tgz b/docs/docsets/RxFireAuth.tgz index 640afb5..6082776 100644 Binary files a/docs/docsets/RxFireAuth.tgz and b/docs/docsets/RxFireAuth.tgz differ diff --git a/docs/index.html b/docs/index.html index 3ce49a3..d1683c8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,7 @@
    -

    RxFireAuth Docs (95% documented)

    +

    RxFireAuth Docs (96% documented)

    diff --git a/docs/search.json b/docs/search.json index 1a43d57..29bdcdf 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:10RxFireAuth32SignInWithAppleCompletionHandlera":{"name":"SignInWithAppleCompletionHandler","abstract":"

    Instances of SignInWithAppleHandler need"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV2idSSSgvp":{"name":"id","abstract":"

    Get the ID.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV5emailSSSgvp":{"name":"email","abstract":"

    Get the email.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11displayNameSSSgvp":{"name":"displayName","abstract":"

    Get the user display name.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11isAnonymousSbvp":{"name":"isAnonymous","abstract":"

    Get if this is an anonymous user.

    ","parent_name":"UserData"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV8fullNameSSSgvp":{"name":"fullName","abstract":"

    Get the full user name.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV16performMigrationSbvp":{"name":"performMigration","abstract":"

    Get if this login operation requires a data migration.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9oldUserIdSSSgvp":{"name":"oldUserId","abstract":"

    Get the old user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9newUserIdSSSgvp":{"name":"newUserId","abstract":"

    Get the new user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html":{"name":"LoginDescriptor","abstract":"

    A login descriptor represents a login operation"},"Structs/UserData.html":{"name":"UserData","abstract":"

    A User.

    "},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","abstract":"

    Get if there is a currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","abstract":"

    Get the currently logged-in user or nil if no user is logged-in.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","abstract":"

    Get an Observable that emits a new item every time the logged-in user is updated.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","abstract":"

    Verify if an account exists on the server with the passed email address.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","abstract":"

    Register a new account on the server with the passed email and credentials.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","abstract":"

    Login an anonymous user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","abstract":"

    Convert an anonymous user to a normal user with an email and a password.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","abstract":"

    Login the specified user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","abstract":"

    Sign in with the passed credentials without first checking if an account","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","abstract":"

    Logout the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","abstract":"

    Update the currently logged-in user taking new values from the","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","abstract":"

    Retrieve the currently logged-in user and use the specified","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","abstract":"

    Update the email of the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","abstract":"

    Confirm the authentication of the passed credentials with the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/LoginProviderManagerType.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","abstract":"

    Sign in with Apple in the passed view controller.

    ","parent_name":"LoginProviderManagerType"},"Protocols/LoginProviderManagerType.html":{"name":"LoginProviderManagerType","abstract":"

    This protocol defines the public API of the wrapper"},"Protocols/UserManagerType.html":{"name":"UserManagerType","abstract":"

    This protocol defines the public API of the main"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO02noD0yA2CmF":{"name":"noUser","abstract":"

    There is no user associated to perform the requested action.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO13invalidUpdateyA2CmF":{"name":"invalidUpdate","abstract":"

    The update cannot be performed because of invalid data.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO15alreadyLoggedInyA2CmF":{"name":"alreadyLoggedIn","abstract":"

    There is already another user logged-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12invalidEmailyA2CmF":{"name":"invalidEmail","abstract":"

    The provided email is not valid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17migrationRequiredyA2CmF":{"name":"migrationRequired","abstract":"

    The action would require to migrate the current user data to a new account.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"UserError"},"Enums/UserError.html#/s:10Foundation14LocalizedErrorP13failureReasonSSSgvp":{"name":"failureReason","parent_name":"UserError"},"Enums/UserError.html":{"name":"UserError","abstract":"

    Errors thrown by UserManagerType implementations.

    "},"Classes/UserManager.html#/s:10RxFireAuth11UserManagerC16clearingKeychainACSb_tcfc":{"name":"init(clearingKeychain:)","abstract":"

    Instanties a new user manager.

    ","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","parent_name":"UserManager"},"Classes/SignInWithAppleHandler.html#/s:10RxFireAuth22SignInWithAppleHandlerC04signE0010completionH0yySSSg_A3Fs5Error_pSgtcSg_tF":{"name":"signIn(completionHandler:)","abstract":"

    Start the Sign in with Apple flow.

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithAuthorization:":{"name":"authorizationController(controller:didCompleteWithAuthorization:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithError:":{"name":"authorizationController(controller:didCompleteWithError:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)presentationAnchorForAuthorizationController:":{"name":"presentationAnchor(for:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html":{"name":"SignInWithAppleHandler","abstract":"

    A helper class that handles the flow of"},"Classes/UserManager.html":{"name":"UserManager","abstract":"

    The default implementation of UserManagerType.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/s:10RxFireAuth32SignInWithAppleCompletionHandlera":{"name":"SignInWithAppleCompletionHandler","abstract":"

    Instances of SignInWithAppleHandler need"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV2idSSSgvp":{"name":"id","abstract":"

    Get the ID.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV5emailSSSgvp":{"name":"email","abstract":"

    Get the email.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11displayNameSSSgvp":{"name":"displayName","abstract":"

    Get the user display name.

    ","parent_name":"UserData"},"Structs/UserData.html#/s:10RxFireAuth8UserDataV11isAnonymousSbvp":{"name":"isAnonymous","abstract":"

    Get if this is an anonymous user.

    ","parent_name":"UserData"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV8fullNameSSSgvp":{"name":"fullName","abstract":"

    Get the full user name.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV16performMigrationSbvp":{"name":"performMigration","abstract":"

    Get if this login operation requires a data migration.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9oldUserIdSSSgvp":{"name":"oldUserId","abstract":"

    Get the old user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html#/s:10RxFireAuth15LoginDescriptorV9newUserIdSSSgvp":{"name":"newUserId","abstract":"

    Get the new user ID.

    ","parent_name":"LoginDescriptor"},"Structs/LoginDescriptor.html":{"name":"LoginDescriptor","abstract":"

    A login descriptor represents a login operation"},"Structs/UserData.html":{"name":"UserData","abstract":"

    A User.

    "},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","abstract":"

    Get if there is a currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP11isAnonymousSbvp":{"name":"isAnonymous","abstract":"

    Get if there is an anonymous user logged-in.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","abstract":"

    Get the currently logged-in user or nil if no user is logged-in.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","abstract":"

    Get an Observable that emits a new item every time the logged-in user is updated.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","abstract":"

    Verify if an account exists on the server with the passed email address.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","abstract":"

    Register a new account on the server with the passed email and credentials.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","abstract":"

    Login an anonymous user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","abstract":"

    Convert an anonymous user to a normal user with an email and a password.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","abstract":"

    Login the specified user on the app.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","abstract":"

    Sign in with the passed credentials without first checking if an account","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","abstract":"

    Logout the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","abstract":"

    Update the currently logged-in user taking new values from the","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","abstract":"

    Retrieve the currently logged-in user and use the specified","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","abstract":"

    Update the email of the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/UserManagerType.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","abstract":"

    Confirm the authentication of the passed credentials with the currently logged-in user.

    ","parent_name":"UserManagerType"},"Protocols/LoginProviderManagerType.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","abstract":"

    Sign in with Apple in the passed view controller.

    ","parent_name":"LoginProviderManagerType"},"Protocols/LoginProviderManagerType.html":{"name":"LoginProviderManagerType","abstract":"

    This protocol defines the public API of the wrapper"},"Protocols/UserManagerType.html":{"name":"UserManagerType","abstract":"

    This protocol defines the public API of the main"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO02noD0yA2CmF":{"name":"noUser","abstract":"

    There is no user associated to perform the requested action.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO13invalidUpdateyA2CmF":{"name":"invalidUpdate","abstract":"

    The update cannot be performed because of invalid data.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO15alreadyLoggedInyA2CmF":{"name":"alreadyLoggedIn","abstract":"

    There is already another user logged-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12invalidEmailyA2CmF":{"name":"invalidEmail","abstract":"

    The provided email is not valid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17migrationRequiredyA2CmF":{"name":"migrationRequired","abstract":"

    The action would require to migrate the current user data to a new account.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO16alreadyAnonymousyA2CmF":{"name":"alreadyAnonymous","abstract":"

    The requested action cannot be performed because there is already an anonymous user logged-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12userNotFoundyA2CmF":{"name":"userNotFound","abstract":"

    The specified user cannot be found.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12userDisabledyA2CmF":{"name":"userDisabled","abstract":"

    The specified user is disabled.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12expiredTokenyA2CmF":{"name":"expiredToken","abstract":"

    The user token has expired.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO13wrongPasswordyA2CmF":{"name":"wrongPassword","abstract":"

    The specified password is invalid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17invalidCredentialyA2CmF":{"name":"invalidCredential","abstract":"

    The specified credential is either expired or invalid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO17emailAlreadyInUseyA2CmF":{"name":"emailAlreadyInUse","abstract":"

    The specified email is already in use in another account.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO12weakPasswordyACSSSgcACmF":{"name":"weakPassword(_:)","abstract":"

    The specified password does not satisfy the basic security requirements.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO05wrongD0yA2CmF":{"name":"wrongUser","abstract":"

    The requested action would target a different user than the one currently signed-in.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO34authenticationConfirmationRequiredyA2CmF":{"name":"authenticationConfirmationRequired","abstract":"

    The requested action requires a recent call to self.confirmAuthentication(email:password:).

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO21providerAlreadyLinkedyA2CmF":{"name":"providerAlreadyLinked","abstract":"

    The specified provider is already linked with this user.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO07networkE0yA2CmF":{"name":"networkError","abstract":"

    An error occurred while reaching Firebase servers.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO013configurationE0yA2CmF":{"name":"configurationError","abstract":"

    The requested operation is not enabled in Firebase Console.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO20invalidConfigurationyA2CmF":{"name":"invalidConfiguration","abstract":"

    The provided Firebase configuration is invalid.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO08keychainE0yACs0E0_pSgcACmF":{"name":"keychainError(_:)","abstract":"

    An error occurred while attempting to access the keychain.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10RxFireAuth9UserErrorO7unknownyACs0E0_pSgcACmF":{"name":"unknown(_:)","abstract":"

    An unknown error has occurred.

    ","parent_name":"UserError"},"Enums/UserError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"UserError"},"Enums/UserError.html":{"name":"UserError","abstract":"

    Errors thrown by UserManagerType implementations.

    "},"Classes/UserManager.html#/s:10RxFireAuth11UserManagerC16clearingKeychainACSb_tcfc":{"name":"init(clearingKeychain:)","abstract":"

    Instanties a new user manager.

    ","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP10isLoggedInSbvp":{"name":"isLoggedIn","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP11isAnonymousSbvp":{"name":"isAnonymous","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP4userAA0D4DataVSgvp":{"name":"user","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP012autoupdatingD00A5Swift10ObservableCyAA0D4DataVSgGvp":{"name":"autoupdatingUser","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP13accountExists4with0A5Swift17PrimitiveSequenceVyAF11SingleTraitOSbGSS_tF":{"name":"accountExists(with:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP8register5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"register(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP16loginAnonymously0A5Swift17PrimitiveSequenceVyAE16CompletableTraitOs5NeverOGyF":{"name":"loginAnonymously()","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20linkAnonymousAccount7toEmail8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"linkAnonymousAccount(toEmail:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP5login5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"login(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP20loginWithoutChecking5email8password14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA15LoginDescriptorVGSS_SSSbSgtF":{"name":"loginWithoutChecking(email:password:allowMigration:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6logout16resetToAnonymous0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSb_tF":{"name":"logout(resetToAnonymous:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update4user0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataV_tF":{"name":"update(user:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP6update24userConfigurationHandler0A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGAA0D4DataVAOc_tF":{"name":"update(userConfigurationHandler:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP11updateEmail03newH00A5Swift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_tF":{"name":"updateEmail(newEmail:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth15UserManagerTypeP21confirmAuthentication5email8password0A5Swift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_SStF":{"name":"confirmAuthentication(email:password:)","parent_name":"UserManager"},"Classes/UserManager.html#/s:10RxFireAuth24LoginProviderManagerTypeP15signInWithApple2in21updateUserDisplayName14allowMigration0A5Swift17PrimitiveSequenceVyAH11SingleTraitOAA0D10DescriptorVGSo16UIViewControllerC_S2bSgtF":{"name":"signInWithApple(in:updateUserDisplayName:allowMigration:)","parent_name":"UserManager"},"Classes/SignInWithAppleHandler.html#/s:10RxFireAuth22SignInWithAppleHandlerC04signE0010completionH0yySSSg_A3Fs5Error_pSgtcSg_tF":{"name":"signIn(completionHandler:)","abstract":"

    Start the Sign in with Apple flow.

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithAuthorization:":{"name":"authorizationController(controller:didCompleteWithAuthorization:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)authorizationController:didCompleteWithError:":{"name":"authorizationController(controller:didCompleteWithError:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html#/c:@CM@RxFireAuth@objc(cs)SignInWithAppleHandler(im)presentationAnchorForAuthorizationController:":{"name":"presentationAnchor(for:)","abstract":"

    Undocumented

    ","parent_name":"SignInWithAppleHandler"},"Classes/SignInWithAppleHandler.html":{"name":"SignInWithAppleHandler","abstract":"

    A helper class that handles the flow of"},"Classes/UserManager.html":{"name":"UserManager","abstract":"

    The default implementation of UserManagerType.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file