Class App

Readonly $addr

Readonly allUsers

Readonly config

Readonly currentUser

Readonly subscribersCount

Readonly syncManager

$resetSharedPtr

• $resetSharedPtr(): void

• Returns void

  Deprecated

  Add DOLLAR_resetSharedPtr to your opt-in list (under classes/App/methods/) to use this.

callFunction

• callFunction(user, name, args, service_name): Promise<Readonly<EJson>>

• Parameters

  • user: Readonly<SyncUser>

  • name: string

  • args: EJson[]

  • service_name: undefined | string

  Returns Promise<Readonly<EJson>>

deleteUser

• deleteUser(user): Promise<void>

• Parameters

  • user: SyncUser

  Returns Promise<void>

getBaseUrl

• getBaseUrl(): string

• Returns string

  Deprecated

  Add get_base_url to your opt-in list (under classes/App/methods/) to use this.

linkUser

• linkUser(user, credentials): Promise<SyncUser>

• Parameters

  • user: SyncUser

  • credentials: Readonly<AppCredentials>

  Returns Promise<SyncUser>

logInWithCredentials

• logInWithCredentials(credentials): Promise<SyncUser>

• Parameters

  • credentials: AppCredentials

  Returns Promise<SyncUser>

logOut

• logOut(): Promise<void>

• Returns Promise<void>

  Deprecated

  Add log_out to your opt-in list (under classes/App/methods/) to use this.

logOutUser

• logOutUser(user): Promise<void>

• Parameters

  • user: SyncUser

  Returns Promise<void>

makeStreamingRequest

• makeStreamingRequest(user, name, args, service_name): Request

• Parameters

  • user: SyncUser

  • name: string

  • args: EJson[]

  • service_name: undefined | string

  Returns Request

pushNotificationClient

• pushNotificationClient(service_name): PushClient

• Parameters

  • service_name: string

  Returns PushClient

refreshCustomData

• refreshCustomData(user): Promise<void>

• Parameters

  • user: SyncUser

  Returns Promise<void>

removeUser

• removeUser(user): Promise<void>

• Parameters

  • user: SyncUser

  Returns Promise<void>

subscribe

• subscribe(observer): AppSubscriptionToken

• Parameters

  • observer: (() => void)

    • • (): void

      • Returns void

  Returns AppSubscriptionToken

switchUser

• switchUser(user): void

• Parameters

  • user: SyncUser

  Returns void

unsubscribe

• unsubscribe(token): void

• Parameters

  • token: AppSubscriptionToken

  Returns void

updateBaseUrl

• updateBaseUrl(base_url): Promise<void>

• Parameters

  • base_url: undefined | string

  Returns Promise<void>

  Deprecated

  Add update_base_url to your opt-in list (under classes/App/methods/) to use this.

userApiKeyProviderClient

• userApiKeyProviderClient(): UserApiKeyProviderClient

• Returns UserApiKeyProviderClient

usernamePasswordProviderClient

• usernamePasswordProviderClient(): UsernamePasswordProviderClient

• Returns UsernamePasswordProviderClient

Static clearCachedApps

• clearCachedApps(): void

• Returns void

Static closeAllSyncSessions

• closeAllSyncSessions(): void

• Returns void

  Deprecated

  Add close_all_sync_sessions to your opt-in list (under classes/App/methods/) to use this.

Static getApp

• getApp(mode, config, sync_client_config): App

• Parameters

  • mode: AppCacheMode

  • config: AppConfig_Relaxed

  • sync_client_config: SyncClientConfig_Relaxed

  Returns App

Static getCachedApp

• getCachedApp(app_id): App

• Parameters

  • app_id: string

  Returns App

  Deprecated

  Add get_cached_app to your opt-in list (under classes/App/methods/) to use this.