Options
All
  • Public
  • Public/Protected
  • All
Menu

Stitch

Singleton class with static utility functions for initializing a StitchAppClient.

Typically, the Stitch.initializeDefaultAppClient method is all you need to instantiate the client (note that, unlike in the browser and server JS SDKs, this method returns a Promise in the React Native SDK):

Stitch.initializeDefaultAppClient('your-stitch-app-id')
  .then((client) => {
    // use client
  })

For custom configurations, see Stitch.initializeAppClient and StitchAppClientConfiguration.

See Also

Hierarchy

  • Stitch

Index

Properties

Static Private defaultClientAppId

defaultClientAppId: string

Static Private localAppName

localAppName: string

Static Private localAppVersion

localAppVersion: string

Accessors

Static defaultAppClient

defaultAppClient:

Retrieves the default StitchAppClient associated with the application.

Methods

Static clearApps

  • clearApps(): void
  • This will clear out all initialized app clients. This method is mainly for debugging, simulating an application restart, as it will clear all clients stored in memory

    Returns void

Static getAppClient

Static hasAppClient

  • hasAppClient(clientAppId: string): boolean

Static initializeAppClient

  • initializeAppClient(clientAppId: string, config?: StitchAppClientConfiguration): Promise<StitchAppClient>

Static initializeDefaultAppClient

  • initializeDefaultAppClient(clientAppId: string, config?: StitchAppClientConfiguration): Promise<StitchAppClient>
  • Initializes the default StitchAppClient associated with the application.

    Parameters

    • clientAppId: string

      The desired clientAppId for the client.

    • Default value config: StitchAppClientConfiguration = new StitchAppClientConfiguration.Builder().build()

      Additional configuration options (optional).

    Returns Promise<StitchAppClient>

    A Promise resolving to an initialized StitchAppClient.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc