StitchAuth

public protocol StitchAuth

A set of methods for retrieving or modifying the authentication state of a StitchAppClient. An implementation can be instantiated with a StitchAppClient instance.

Properties

  • Whether or not the client containing this StitchAuth object is currently authenticated.

    Declaration

    Swift

    var isLoggedIn: Bool { get }

  • A StitchUser object representing the user that the client is currently authenticated as. nil if the client is not currently authenticated.

    Declaration

    Swift

    var currentUser: StitchUser? { get }

Authentication Provider Clients

  • Retrieves the authenticated authentication provider client for the authentication provider associated with the specified factory.

    Declaration

    Swift

    func providerClient<Factory>(fromFactory factory: Factory) -> Factory.ClientT where Factory : AuthProviderClientFactory, Factory.RequestClientT == StitchAuthRequestClient

    Parameters

    fromFactory

    The AuthProviderClientFactory which will provide the client for this authentication provider. Each authentication provider that has extra functionality beyond logging in/linking will offer a static factory which can be used for this method.

    Return Value

    an authentication provider client whose type is determined by the Client typealias in the type specified in the fromFactory parameter.

  • Retrieves the authentication provider client for the authentication provider associated with the specified factory.

    Declaration

    Swift

    func providerClient<Factory>(fromFactory factory: Factory) -> Factory.ClientT where Factory : AuthProviderClientFactory, Factory.RequestClientT == StitchRequestClient

    Parameters

    fromFactory

    The AuthProviderClientFactory which will provide the client for this authentication provider. Each authentication provider that has extra functionality beyond logging in/linking will offer a static factory which can be used for this method.

    Return Value

    an authentication provider client whose type is determined by the Client typealias in the type specified in the fromFactory parameter.

  • Retrieves the authenticated authentication provider client for the authentication provider associated with the specified name and factory.

    Declaration

    Swift

    func providerClient<Factory>(fromFactory factory: Factory, withName name: String) -> Factory.Client where Factory : NamedAuthProviderClientFactory

    Parameters

    fromFactory

    The NamedAuthProviderClientFactory which will provide the client for this authentication provider. Each named authentication provider that has extra functionality beyond logging in/linking will offer a static factory which can be used for this method.
    withName

    The name of the authentication provider as defined in the MongoDB Stitch application.

    Return Value

    an authentication provider client whose type is determined by the Client typealias in the type specified in the fromFactory parameter.

Authentication Actions

  • Authenticates the client as a MongoDB Stitch user using the provided StitchCredential.

    Declaration

    Swift

    func login(withCredential credential: StitchCredential, _ completionHandler: @escaping (StitchResult<StitchUser>) -> Void)

    Parameters

    withCredential

    The StitchCredential used to authenticate the client as a particular user. Each authentication provider has an implementation of StitchCredential that can be used with this method.
    completionHandler

    The completion handler to call when the login is complete. This handler is executed on a non-main global DispatchQueue. If the operation is successful, the result will contain a StitchUser object representing the user that the client is now authenticated as.

  • Logs out the currently authenticated user, and clears any persisted authentication information.

    Declaration

    Swift

    func logout(_ completionHandler: @escaping (StitchResult<Void>) -> Void)

    Parameters

    completionHandler

    The completion handler to call when the logout is complete. This handler is executed on a non-main global DispatchQueue.

Delegate Registration

  • Registers a StitchAuthDelegate with the client. The StitchAuthDelegate‘s onAuthEvent(:fromAuth) method will be called with this StitchAuth as the argument whenever this client is authenticated or is logged out.

    Important

    StitchAuthDelegates registered here are stored as weak references, meaning that if there are no more strong references to a provided delegate, its onAuthEvent(:fromAuth) method will no longer be called on authentication events.

    Declaration

    Swift

    func add(authDelegate: StitchAuthDelegate)

    Parameters

    authDelegate

    A class conforming to StitchAuthDelegate, whose onAuthEvent(:fromAuth) method should be called whenever this client experiences an authentication event.