Interacting with Stitch

Stitch is the singleton class with static utility functions for initializing the SDK.

Use it to initialize and retrieve a StitchAppClient for your Stitch app.

The StitchAppClient has the fundamental set of methods for communicating with a MongoDB Stitch application backend.

An implementation can be initialized or retrieved using the Stitch utility class.

This protocol provides access to the StitchAuth for login and authentication.

Using serviceClient, you can retrieve services, including the RemoteMongoClient for reading and writing on the database. To create a RemoteMongoClient, pass remoteMongoClientFactory into serviceClient(fromFactory:withName).

You can also use it to execute Stitch Functions.

Finally, its StitchPush object can register the current user for push notifications.

The StitchAuth provides methods for retrieving or modifying the authentication state of a StitchAppClient.

Each StitchAppClient has an instance of StitchAuth.

Information about the logged-in StitchUser is available in the currentUser property.

To watch for auth events, add a StitchAuthDelegate.

StitchAuthDelegate is a protocol to be inherited when you need to take action on authentication events. An instance of a StitchAuthDelegate must be added to a StitchAuth.

StitchPush can be used to get clients that can register for push notifications via Stitch.

StitchServiceClient acts as a general purpose client for working with services that are not defined or well defined by this SDK. It has methods similar to the callFunction method on StitchAppClient.

The StitchUser represents the the user who is logged in to the StitchAppClient.

You can retrieve an instance from StitchAuth or from the StitchResult of certain methods.

You will find information about the user such as name and email address in the StitchUserProfile property profile.

The StitchUserProfile describes a StitchUser.

Every StitchUser has a StitchUserProfile member.

See ExtendedStitchUserProfile for additional fields available on this type.

The StitchUserIdentity represents an identity that a StitchUser is linked to and can use to log in to their account.

StitchResult holds the result to an asynchronous operation performed against the Stitch server.

When an operation completes successfully, the StitchResult holds the result of the operation. When the operation fails, the StitchResult contains a StitchError object describing the reason for the failure.