Web SDK documentation
  1. Injectables
  2. InterAppService

File

core/common/inter-app.service.ts

Description

Service that provides methods to interact with other applications. It allows retrieving a specific app by key, checking its availability, verifying if it is not the current application, determining if a link to another app should be shown, and navigating to it.

Index

Methods

Methods

getApp$
getApp$(key: T)

Retrieve application by its key as observable.

Parameters :
Name Type Optional Description
key T No
  • Application key.
Returns : Observable<IApplication | undefined>

Observable of Application
isCurrentApp$
isCurrentApp$(key: T)

Checks if current application is the same as the one that key is provided

Parameters :
Name Type Optional Description
key T No
  • Application key.
Returns : Observable<boolean>

Observable of boolean; true if current app matches provided key.
Async navigateToApp
navigateToApp(appKey: T, path?: string)

Navigates to app by provided app key

Parameters :
Name Type Optional Description
appKey T No
  • Application key that links leads to.
path string Yes
  • Additional path in target application.
Returns : any
shouldShowAppLink$
shouldShowAppLink$(appKey: T)

Checks if other (other than current) application link should be displayed. It consists of two conditions:

  • app that link leads to exists and is available for current user
  • app link leads to app that is not current app
Parameters :
Name Type Optional Description
appKey T No
  • Application key that link leads to.
Returns : Observable<boolean>

Observable of boolean; only true when app that link leads to is available and app link leads to app that is not current app

results matching ""

    No results matching ""