Options
All
  • Public
  • Public/Protected
  • All
Menu

altogic

Index

Type Aliases

ListenerFunction: ((payload: EventData) => void)

Type declaration

    • Defines the structure of listener (callback) functions for realtime events (messages). Basically a listener function accepts only a single parameter of event data.

      export

      Parameters

      Returns void

UserEventListenerFunction: ((eventName: string, session: Session | null) => void)

Type declaration

    • (eventName: string, session: Session | null): void
    • Defines the structure of listener (callback) functions for user generated events (messages).

      eventName - The user event that has been triggered. Possible value are user:signin, user:signout, user:update, user:delete, user:pwdchange, user:emailchange, user:phonechange.

      session - The user session object that has triggered the event. If the event is triggered by the user without a session then this value will be null.

      export

      Parameters

      • eventName: string
      • session: Session | null

      Returns void

Functions

  • Creates a new client to interact with your backend application developed in Altogic. You need to specify the envUrl and clientKey to create a new client object. You can create a new environment or access your app envUrl from the Environments view and create a new clientKey from App Settings/Client library view in Altogic designer.

    Parameters

    • envUrl: string

      The base URL of the Altogic application environment where a snapshot of the application is deployed

    • clientKey: string

      The client library key of the app

    • Optional options: ClientOptions

      Additional configuration parameters

    Returns AltogicClient

    The newly created client instance

Generated using TypeDoc