Interface Window

Type declaration

• API: {
      removeRequestListener: (() => void);
      requestListener: ((callback) => void);
  }

  • removeRequestListener: (() => void)

    • • (): void

      • Removes an API:request event ipc listener

        Returns void

  • requestListener: ((callback) => void)

    • • (callback): void

      • Register an API:request event ipc listener

        Parameters

        • callback: any

          event handler

        Returns void

• MetaStoreInstance: {
      removeListener: (() => void);
      setInstanceListener: ((navigate) => void);
  }

  • removeListener: (() => void)

    • • (): void

      • Returns void

  • setInstanceListener: ((navigate) => void)

    • • (navigate): void

      • Listens from menù Settings->Set MetaStore instance event, then goes to MetaStore_instance page

        Parameters

        • navigate: NavigateFunction

        Returns void

• auth: {
      abortSignIn: (() => any);
      authContextListener: ((setAuth) => void);
      configOIDC: ((config) => any);
      removeAuthContextListener: (() => void);
      signIn: (() => any);
      signOut: (() => any);
  }

  • abortSignIn: (() => any)

    • • (): any

      • Cancels a sign in process without complete it

        Returns any

  • authContextListener: ((setAuth) => void)

    • • (setAuth): void

      • IPC listener for auth:authContext events, that are events that changes the AuthContext values

        Parameters

        • setAuth: Dispatch<SetStateAction<IAuthContextProps>>

          set the auth state

        Returns void

  • configOIDC: ((config) => any)

    • • (config): any

      • Send keycloak configuration parameters based on selected MetaStore instance

        Parameters

        • config: any

        Returns any

  • removeAuthContextListener: (() => void)

    • • (): void

      • Returns void

  • signIn: (() => any)

    • • (): any

      • IPC for 2 ways communication. Performs login.

        Returns any

        Promise that resolves with the response from the main process.

  • signOut: (() => any)

    • • (): any

      • Returns any

• infos: {
      getConstants: ((callback) => any);
  }

  • getConstants: ((callback) => any)

    • • (callback): any

      • One time listener to get some useful constants variables

        Parameters

        • callback: any

        Returns any

• maskHandler: {
      getVisibilityState: ((path) => any);
      insertIntoVisibilityState: ((mask, pathToInsert) => any);
      assignMaskHandler(mask, schemaMaskId) => void;
      unsetMaskHandler() => void;
  }

  • getVisibilityState: ((path) => any)

    • • (path): any

      • To get the visibility state from renderer process

        Parameters

        • path: string

        Returns any

  • insertIntoVisibilityState: ((mask, pathToInsert) => any)

    • • (mask, pathToInsert): any

      • To insert a visibility state group from renderer process after the first schema rendering

        Parameters

        • mask: any

        • pathToInsert: string

        Returns any

  • assignMaskHandler:function

    • assignMaskHandler(mask, schemaMaskId): void

    • Triggers the MaskHandler object initialization

      Parameters

      • mask: any

      • schemaMaskId: string

      Returns void

  • unsetMaskHandler:function

    • unsetMaskHandler(): void

    • Unsets the MaskHandler object, when a new schema is rendered

      Returns void

• store: {
      handleElectronStoreChange: ((callback, subChannel) => void);
      removeElectronStoreChangeHandler: ((subChannel) => void);
      get(key) => any;
      set(property, val, setMask?) => void;
  }

  • handleElectronStoreChange: ((callback, subChannel) => void)

    • • (callback, subChannel): void

      • Register an event listener for the electronStoreDidChange message (sent by electron-store onDidAnyChange method via mainWindow.webContents.send)

        Parameters

        • callback: any

          event handler for the electronStoreDidChange event

        • subChannel: string

        Returns void

  • removeElectronStoreChangeHandler: ((subChannel) => void)

    • • (subChannel): void

      • Remove the event listener for the electronStoreDidChange event.

        Parameters

        • subChannel: any

        Returns void

  • get:function

    • get(key): any

    • Parameters

      • key: any

      Returns any

  • set:function

    • set(property, val, setMask?): void

    • Parameters

      • property: any

      • val: any

      • setMask: boolean = true

      Returns void