Class ClientSessionGyro

Method Details

• getSessionInstance

  public static ClientSessionGyro getSessionInstance()

  Gets the runtime application instance for the current thread in a client session.

  Returns:

  The RuntimeApp instance when called from a thread of the client session, null otherwise.

• getSessionInstance

  public static ClientSessionGyro getSessionInstance(SessionInfo sessionInfo)

  Gets the runtime application instance for the current thread in a client session.

  Parameters:

  sessionInfo - A session information instance, or null for none.

  Returns:

  The RuntimeApp instance when called from a thread of the client session, null otherwise.

• setApplication

  public void setApplication(RuntimeApp runtimeApp)

  Sets the runtime application. This method is not intended to be called by user code, it is used by the framework.

  Parameters:

  runtimeApp - The runtime application.

  Throws:

  IllegalStateException - If runtime application has been set.

• addDisposeListener

  public boolean addDisposeListener(IClientSessionDisposeListener listener)

  Adds a dispose listener for the client session. Calling this method multiple times with the same listener will have no effect (but to return false).

  Specified by:

  addDisposeListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to add.

  Returns:

  true if the listener was added, false otherwise.

  Throws:

  NullPointerException - If the listener is null.

• removeDisposeListener

  public boolean removeDisposeListener(IClientSessionDisposeListener listener)

  Removes a dispose listener for the client session.

  Specified by:

  removeDisposeListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to remove.

  Returns:

  true if listener is successfully removed, false otherwise.

• dispose

  public boolean dispose()

  Disposes of the Gyro instance so the client session ends.

  Specified by:

  dispose in interface IClientSessionGyro

  Returns:

  true for dispose success, false if already disposed of.

• isDisposed

  public boolean isDisposed()

  Checks if the client session Gyro is disposed of.

  Specified by:

  isDisposed in interface IClientSessionGyro

  Returns:

  true if disposed, false otherwise.

• getPrivateStorageMap

  public Map<String,Object> getPrivateStorageMap()

  Gets the concurrent hash map used to store the private data.

  Specified by:

  getPrivateStorageMap in interface IPrivateStorage

  Returns:

  The private storage map.

• getClientEndPoint

  public ClientEndPoint getClientEndPoint()

  Gets the client end point instance.

• getEntryParameter

  public String getEntryParameter(String name)

  Gets a parameter of the URL the client entered the application with: one of the "other" parameters of its ClientParams, the ones the server does not read itself (CC-LOGIN-L10A1-SERVER-GAPS, SignIn flow D-16).

  Specified by:

  getEntryParameter in interface IClientSessionGyro

  Parameters:

  name - The parameter name, e.g. "prt".

  Returns:

  The value, or null when the entry URL carries none with that name, and when the client has not connected.

• getAppSessionGyro

  public AppSessionGyro getAppSessionGyro()

  Gets the Gyro for the application session.

  Specified by:

  getAppSessionGyro in interface IClientSessionGyro

• getClientSessionInfo

  public SessionInfo getClientSessionInfo()

  Gets the client sessions information.

  Specified by:

  getClientSessionInfo in interface IClientSessionGyro

  Returns:

  The session information instance.

• getRuntimeApp

  public RuntimeApp getRuntimeApp()

  Gets the RuntimeApp for the Gyro instance.

  Returns:

  The runtime app for the client session.

• getVirtualizedPropFromReference

  public GProp<?> getVirtualizedPropFromReference(String reference)

  Attempts to look up a virtualized property from a reference by searching this instance.

  Specified by:

  getVirtualizedPropFromReference in interface IClientSessionGyro

  Specified by:

  getVirtualizedPropFromReference in interface IVirtualizedReferenceLookup

  Parameters:

  reference - The reference to look-up.

  Returns:

  The virtualized instance of the property, null if not found.

• getKStringInfoProvider

  public IPropMgrInfoProvider getKStringInfoProvider()

  Retrieves the IPropMgrInfoProvider for the client session.

  Specified by:

  getKStringInfoProvider in interface IClientSessionGyro

  Specified by:

  getKStringInfoProvider in interface ILocaleString

  Returns:

  The KString information provider instance, or null if not possible. The instance also supports SVG caching and Custom CSS.

• getOpenNativeSettings

  public IOpenNativeSettings getOpenNativeSettings() throws NotFoundException

  Get the open native settings interface for the client-specific instance, supported only on iiziRun clients running iiziRun-based clients for Android and iOS.

  Specified by:

  getOpenNativeSettings in interface IClientSessionGyro

  Returns:

  The open native settings interface. In order to test support for open native settings operations, use IOpenNativeSettings.isSupported().

  Throws:

  NotFoundException - In case the open native settings instance is not found, typically if the client session is under creation, or it has been disposed of.

• getFlashlight

  public IFlashlight getFlashlight() throws NotFoundException

  Gets the flashlight client-specific instance, currently only supported for operations on iiziRun clients for Android and iOS.

  Specified by:

  getFlashlight in interface IClientSessionGyro

  Returns:

  The flashlight instance. In order to test support of flashlight operations, use IFlashlight.isSupported().

  Throws:

  NotFoundException - In case the flashlight instance is not found, typically if the client session is under creation, or it has been disposed of.

• getEnvironment

  public EnvProps getEnvironment()

  Gets the current environment properties for Selector's or Value's.

  This is NOT the same instance as the one available from the AppSessionGyro.getEnvironment().

  Specified by:

  getEnvironment in interface IClientSessionGyro

  Returns:

  The current environment properties for selectors, null if client hasn't sent them yet.

• getLanguageCode

  public String getLanguageCode()

  Gets the language code to use for the client session, or if not defined, the application session language code.

  Specified by:

  getLanguageCode in interface IClientSessionGyro

  Returns:

  The language code, or null for default.

• getUIFocusEngine

  public IFocusEngine getUIFocusEngine()

  Returns the UI focus engine instance for the specified component.

  Specified by:

  getUIFocusEngine in interface IClientSessionGyro

  Returns:

  The UI focus engine instance.

• getFocusEngine

  public IFocusEngine getFocusEngine(IFocusComp comp)

  Returns the focus engine instance for the specified component.

  Specified by:

  getFocusEngine in interface IFocusEngineProvider

  Parameters:

  comp - The component requesting the focus engine.

  Returns:

  The focus engine instance, or null if not found.

• getClientTimerEngine

  public ITimerEngine getClientTimerEngine()

  Gets the client timer engine. All timer tasks as disposed of automatically when the client session exits.

  Specified by:

  getClientTimerEngine in interface IClientSessionGyro

  Returns:

  The client session implementation of the timeout engine.

• getClientWorker

  public Worker getClientWorker()

  Gets the Client Worker.

  Specified by:

  getClientWorker in interface IClientSessionGyro

  Returns:

  The Client worker instance.

• getPushNotificationAPI

  public IPushNotificationAPI getPushNotificationAPI()

  Gets the Push Notification (PN) API of this client session, created on first use (P4-04). Its callbacks run on getClientWorker(); its client-bound calls go down the channel the client created under $env (P4-06) and fail with no_device in a session without one.

  Specified by:

  getPushNotificationAPI in interface IClientSessionGyro

  Returns:

  The API, never null in a server client session.

• getFileUploadAPI

  public IClientUploadAPI getFileUploadAPI()

  Gets the file upload API of this client session: the server side of the upload channel the client created under $env. A client's request to upload files is reserved or refused there, and its reservations are observed there.

  Specified by:

  getFileUploadAPI in interface IClientSessionGyro

  Returns:

  The API, never null in a server client session; its IClientUploadAPI.isEnabled() is false when the client has no upload channel or the server no upload service.

• getPrettyLocaledTexts

  public PrettyLocaledTexts getPrettyLocaledTexts()

  Gets the locale'd texts instance for the sessions language and text tables.

  Specified by:

  getPrettyLocaledTexts in interface IClientSessionGyro

  Returns:

  The instance used to create locale'd strings for e.g. duration and distances.

• getAppSessionFileProvider

  public WSFileProvider getAppSessionFileProvider() throws IOException

  Get the web server file provider for the client session.

  Returns:

  The web server file provider.

  Throws:

  IOException - If the directory for the client session files failed to be created.

  IllegalStateException - If the client session is disposed of.

• getNextPanelAnimation

  public int getNextPanelAnimation()

  Returns the animation that will be used for next panel that replaces another panel.

  This animation only applies to full-page panels.

  This value is reset to IUIPanelAnimation.ANIMATION_DEFAULT as soon as a panel replacement has been made.

  Specified by:

  getNextPanelAnimation in interface IClientSessionGyro

  Returns:

  The composite animation value, or IUIPanelAnimation.ANIMATION_DEFAULT for none.

• setNextPanelAnimation

  public int setNextPanelAnimation(int nextAnimation)

  Sets the animation that will be used for next panel that replaces another panel.

  This animation only applies to full-page panels.

  This value is reset to IUIPanelAnimation.ANIMATION_DEFAULT as soon as a panel replacement has been made.

  Specified by:

  setNextPanelAnimation in interface IClientSessionGyro

  Returns:

  The old "next panel animation" composite animation value, or IUIPanelAnimation.ANIMATION_DEFAULT for none.

• getVirtualizedPanels

  public UIPanelBase[] getVirtualizedPanels()

  Gets the cached and sorted array of panels that is currently displayed.

  The index 0 is the topmost panel and the higher the index, the more overlapped the panel is. The highest index is the top-level main panel covering the screen.

  Do not modify this array!

  Specified by:

  getVirtualizedPanels in interface IClientSessionGyro

  Returns:

  The virtualized panels.

• getTopmostPanel

  public UIPanelBase getTopmostPanel()

  Gets the current top-most panel.

  Specified by:

  getTopmostPanel in interface IClientSessionGyro

  Returns:

  The panel, null if none has been created.

• getMatchingPanels

  public UIPanelBase[] getMatchingPanels(VirtualSpace virtualSpace)

  Gets the panels that matches a VirtualSpace for this client session. The VirtualSpace can be virtualized or not, and the client session environment properties are used to determine the panels in question (i.e. depending on their selectors).

  This method is quite CPU intensive and should NOT be done too often. The return value is however cached during the focus handler mappings from VirtualSpace to the UI, so only one such call is done.

  The ordering is significant and can be a mix of primary and secondary panels, however the matching panel is the virtualized instance if one is present, otherwise it is the non-virtualized instance.

  Note: The result from this method should not be cached because the matching panels may very well change during a client session due to e.g. a change in client capabilities or alike (that affects the result of the selectors used).

  Specified by:

  getMatchingPanels in interface IClientSessionGyro

  Parameters:

  virtualSpace - The VirtualSpace to look-up the panels for.

  Returns:

  A cloned cached array of the matching panels.

  The array of matching panels, can be a mix of virtualized and non-virtualized panels!

• requestUILock

  public ILockState requestUILock()

  Requests a UI lock state. The object returned can be used to set a message below the lock spinner. It can also be used to set a progress indicator, also below the spinner. A progress indicator can also be handled using the lock object.

  Note: You MUST call the objects {link @ILockState#release()} method to release the lock state.

  Specified by:

  requestUILock in interface IClientSessionGyro

  Returns:

  The lock state object.

  Throws:

  IllegalStateException - If the client session is disposed of.

• setBusy

  public void setBusy(KString msg, int delay, int progress)

  Sets the UI busy state and optionally updates the message and/or progress.

  This method is intended to be used with advanced UI programming where a message is used in conjunction with a progress.

  If this functionality is not required, it is recommended to let the AppSessionGyro handle the busy state.

  Specified by:

  setBusy in interface IClientSessionGyro

  Parameters:

  msg - Optional message, null for none.

  delay - Delay of lock spinner: -2 for default (1.5 second), -1 disabled, 0=no delay, >0 wait time in milliseconds (1-20000, i.e. 20 seconds).

  progress - Progress value, -1 for none, otherwise a value between 0 and 100.

  Throws:

  IllegalArgumentException - If progress value is not -1 or 0 to 100, or delay is smaller than -2 or larger than 20000.

• setReady

  public void setReady()

  Sets the UI to "ready", i.e. clears busy state.

  Note: the state is not set to ready immediately, merely the busy state. The UI is triggered to be synchronized with the VirtualSpace in the Client Worker thread, and a change of panel may be the result.

  This method is intended to be used with advanced UI programming where a message is used in conjunction with a progress.

  If this functionality is not required, it is recommended to let the AppSessionGyro handle the busy state.

  Specified by:

  setReady in interface IClientSessionGyro

• setReady

  public boolean setReady(Runnable runnable)

  Sets the UI to "ready", i.e. clears busy state.

  Note: the state is not set to ready immediately, merely the busy state. The UI is triggered to be synchronized with the VirtualSpace in the Client Worker thread, and a change of panel may be the result.

  Specify a runnable instance if you wish to be notified when the panel is unlocked. This runnable will be called at a later stage from the Client Worker thread.

  The runnable will be be called if the busy state is turned on or the client has been locked.

  This method is intended to be used with advanced UI programming where a message is used in conjunction with a progress.

  If this functionality is not required, it is recommended to let the AppSessionGyro handle the busy state.

  Specified by:

  setReady in interface IClientSessionGyro

  Parameters:

  runnable - The runnable to be notified, null for none.

  Returns:

  true if the runnable will be called (if present), false if it will not be called.

• enterClientLock

  public void enterClientLock(boolean isFromClient)

  Method called whenever the client lock state is enabled.

  Specified by:

  enterClientLock in interface IClientSessionGyro

  Parameters:

  isFromClient - Flag indicating the state change is induced from client side. If this flag is false, the lock state

• exitClientLock

  public void exitClientLock()

  Releases client lock state if the client is not in busy state. The lock state will be released when the VS has been synchronized at a later stage, but very quickly.

  Specified by:

  exitClientLock in interface IClientSessionGyro

• getHistoryRequest

  public HistoryRequest getHistoryRequest()

  Gets the history request instance for the client session.

  Specified by:

  getHistoryRequest in interface IClientSessionGyro

  Returns:

  This client session's instance for history requests, never changes during the session's lifetime.

• addHistoryEntry

  public IAppHistoryEntry addHistoryEntry()

  Adds a new focus entry at the current location for this client session. The VirtualSpace and UI location is recorded to the previous and forward locations in the entry.

  The entry is added at the current index and will clear all forward operations at that point to the end, i.e. IAppHistory.clearForwardEntries() is called before adding the entry and moving the index forward by one (1).

  Once added, the history entry forward and backward information can be set or adjusted.

  Specified by:

  addHistoryEntry in interface IClientSessionGyro

  Returns:

  The newly added history entry, null if history operations are currently in progress (i.e. a forward or backward history operation is running).

• synchronizeCurrentFocusWithVS

  public boolean synchronizeCurrentFocusWithVS()

  Updates the focus to the VS from the current focused UI component. This may be needed to synchronize the VS focus for a particular UI session to make sure it is synchronized.

  Specified by:

  synchronizeCurrentFocusWithVS in interface IClientSessionGyro

  Returns:

  true for success, false if nothing was done.

• setPseudoActionFocusToVS

  public void setPseudoActionFocusToVS(IUIFocusComp focusComp, IGProp<?> trigger)

  Called when a "pseudo UI action" is executed, making sure its VS counterpart has the current focus. This "pseudo action" can be e.g. a MLItemProp that has a context menu, as well as an direct action such as a UIButton.

  This method is not intended to be called but is used internally by the framework.

  Specified by:

  setPseudoActionFocusToVS in interface IClientSessionGyro

  Parameters:

  focusComp - The "pseudo action" focus component.

  trigger - The trigger component, null for none.

• onFocusChanged

  public void onFocusChanged(IFocusComp newComp, IFocusComp oldComp, IGProp<?> trigger, boolean isRemoteInduced, boolean isInternal)

  Called when focus changes.

  Specified by:

  onFocusChanged in interface IGyroFocusEngineOwner

  Parameters:

  newComp - New focus component.

  oldComp - Old focus component.

  trigger - The trigger property, null for none.

  isRemoteInduced - If the event is remote induced.

  isInternal - The internal flag as specified in the setFocus method to the focus engine.

• onFocusVetoChange

  public void onFocusVetoChange(FocusEvent event) throws FocusVetoException

  Called to perform veto.

  Specified by:

  onFocusVetoChange in interface IGyroFocusEngineOwner

  Parameters:

  event - The focus event, InternalFocusEvent perhaps.

  Throws:

  FocusVetoException - When the focus is veto'ed.

• getCurrentFocus

  public UIComp getCurrentFocus()

  Returns the current focus in the UI. If no particular component is in focus, the panel that last has focus or the topmost panel is returned.

  Specified by:

  getCurrentFocus in interface IClientSessionGyro

  Returns:

  The component in focus, or null if not a single panel has yet been created.

• installFonts

  public boolean installFonts(List<FontFiles> fontList)

  Installs the font face as specified by the FontFiles instance for the Client Session. Once installed, the font family can be used.

  Parameters:

  fontList - The list of font files to install.

  Returns:

  true for success, false if the remote part doesn't support installation, e.g. in a preview browser.

• installFont

  public boolean installFont(String fontFamily)

  Installs the font families as specified by the font family.

  Parameters:

  fontFamily - The font family or families.

  Returns:

  true for success, false if the remote part doesn't support installation, e.g. in a preview browser.

• getClientContextMenuReference

  public String getClientContextMenuReference(UIContextMenu contextMenu)

  Gets the reference to use for a context menu.

  Parameters:

  contextMenu - The context menu.

  Returns:

  The reference to use, empty string for none (never null).

• getClientContextMenuReference

  public String getClientContextMenuReference(UIContextMenu contextMenu, boolean fullPropReference)

  Gets the reference to use for a context menu.

  Specified by:

  getClientContextMenuReference in interface IClientSessionGyro

  Parameters:

  contextMenu - The context menu.

  fullPropReference - Flag indicating a full property reference string should be returned, false for short (used internally by the server).

  Returns:

  The reference to use, empty string for none (never null).

  Throws:

  IllegalArgumentException - If the context menu is not a stand-alone context menu but a child of a panel component.

• getOpenFloat

  public UIFloat getOpenFloat()

  Gets the Float that is open in this client session: the first Float among the panels shown, topmost first.

  Specified by:

  getOpenFloat in interface IUIFloatHost

  Returns:

  The virtualized Float, or null if none is open.

• openFloat

  public UIFloat openFloat(UIFloat floatPanel, UIPanelBase owner, UIComp anchor) throws PropException

  Opens a Float in this client session: the Float is virtualized and added to the panels shown, under the lock of the client session and in the way a panel is added for the VS focus (see virtualizeAndGetFocus): a removed but not yet destroyed instance of it is destroyed first, and the cache of the panels shown is reset. Of that path, four steps are repeated here and nothing else - not the themes, not the replace loop, not the animation. The initial focus is then set as for every newly displayed panel, after the lock: the field the current VS focus maps to inside the Float, else its first focusable field, else the Float itself (IIZI-SRV-NEW-PANEL-NOBODY-FOCUSED). The themes are not set because that flips the themes of the whole client when the panel's do not fit the ones shown, and a Float is shown over a surface that must stay as it is: a Float takes the themes of the surface it is opened over, and a WARNING is logged when its own do not fit them.

  The owner is shown beneath the Float (ruling FL-3 of 2026-09-27). A client session that does not show the owner presents it first, the way the VS focus presents a panel - the panels it replaces are removed, its animation and OnUIConnect run - and adds the Float above it; the anchor, mapped into this session, is then found. That is one navigation: one history entry is added for the owner and the Float together, and it carries the Float, so that a history forward opens the Float again over the owner. An owner that cannot be presented here - it does not participate for this client session, has no VirtualSpace or no component - is logged as a warning, and the Float opens over what is shown, centred.

  A Float must have a VirtualSpace, its own or its owner's: no panel is virtualized without one, and an open Float is an attached panel of it. A Float that has neither is refused. So is a Float that does not participate for this client session, because the VS synchronization forces a change of panels on every run while a panel shown does not participate.

  The owner and the anchor are passed as the caller knows them, virtualized in any client session or not at all, and are mapped into this one. The anchor is set as the UIFloat.PN_ANCHOR property of the virtualized Float before it is added, so that it travels with the panel, as the path the client resolves it with: from the client root, with a leading slash. An anchor whose panel is not shown in this client session is dropped with a warning, and the Float is centred.

  This method is called from any thread: the worker of this client session, the application session worker, or the worker of another client session when a Float is opened in every client session. The lock is the one the VS focus takes to add or remove panels, taken in the same order as there - before the lock of the property tree, which the property operations take themselves - and the change reaches the client through its own worker, as every change of the client tree does.

  Specified by:

  openFloat in interface IUIFloatHost

  Parameters:

  floatPanel - The Float to open, non-virtualized.

  owner - The owner panel the Float is opened for, virtualized or not.

  anchor - The component the Float is anchored to, virtualized or not, null to centre the Float.

  Returns:

  The virtualized Float that was added, never null.

  Throws:

  PropException - If the Float has no VirtualSpace, does not participate for this client session, or cannot be virtualized or added.

• closeFloat

  public boolean closeFloat(UIFloat virtualFloat)

  Closes a Float that is open in this client session: its removal is requested, as the client session does for every panel it removes, and the cache of the panels shown is reset, so that getVirtualizedPanels() and getTopmostPanel() no longer answer it. The client closes it, with or without its animation, and disposes of it.

  The focus then returns to the field that had it when the Float opened, else to the owner panel (ruling FL-6 of 2026-09-27, restoreFloatFocus(ClientSessionGyro.FloatOpening)) - when the Float still is the topmost panel: a dialog opened above it has the focus and keeps it.

  Specified by:

  closeFloat in interface IUIFloatHost

  Parameters:

  virtualFloat - The virtualized Float, as returned by getOpenFloat().

  Returns:

  true if the removal was requested, false if it already had been, or the Float is not a virtualized Float of this client session, which is logged.

• getLocale

  public LocaleInfo getLocale()

  Gets the local info class instance.

  Specified by:

  getLocale in interface ILocaleString

  Returns:

  The locale info class instance when the client environment has been set, otherwise the default client locale info instance specified for the server.

• setLocale

  public LocaleInfo setLocale(LocaleInfo locale)

  Changes or sets the LocaleInfo for the environment.

  Specified by:

  setLocale in interface IClientSessionGyro

  Parameters:

  locale - localeInfo The locale information to use.

  Returns:

  The old LocaleInfo, or null if not set.

• getLocaleKString

  public KString getLocaleKString(String id, boolean system)

  Gets the KString of a particular ID from the app's text tables that are flagged to also handle LocaleString's depending on the flag.

  Specified by:

  getLocaleKString in interface ILocaleString

  Parameters:

  id - The text ID.

  system - Flagged to handle system strings for LocaleString's.

  Returns:

  The KString for the text ID in current locale, null if not found.

• messageBox

  public void messageBox(IMessageBoxReply reply, IMessageBox.Icon icon, KString title, KString message, KString... buttons)

  Displays a message box with the specified title and message.

  The callback is done in the client worker thread, except for IMessageBoxReply.SESSION_CLOSED, which is told in the thread disposing of the client session.

  Specified by:

  messageBox in interface IMessageBox

  Parameters:

  reply - The reply callback that is called when the user chooses a button or session is closed, null for none.

  icon - Icon to display, see the {link Icon} enumeration.

  title - The title string, must be non-null.

  message - The message to display, must be non-null.

  buttons - The strings for the buttons to display, if none, just an OK button is displayed. This array of buttons defined the index value returned by this method.

  Throws:

  NullPointerException - If icon or message is null, or if any of the elements in buttons array is null.

• toast

  public void toast(KString message, IToaster.Position position, IToaster.Direction direction, IToaster.Type type, int duration)

  Displays a simple, unobstructive and ephemeral text message to the user.

  Specified by:

  toast in interface IToaster

  Parameters:

  message - The message to display, cannot be null.

  position - Position of toast, default value is Position.BOTTOM_CENTER if null.

  direction - Direction of the toast animation, default Direction.UP if null.

  type - Type of message style: message, warning, error of fatal, default is message if null.

  duration - Duration of the toast message being shown in ms. Valid values are in the interval [0, 10000], 0 for a sticky toast.

• getScreenWidth

  public int getScreenWidth()

  Gets the current screen width.

  Specified by:

  getScreenWidth in interface IClientSessionGyro

  Returns:

  The current screen width, or zero if not initialized.

• getScreenHeight

  public int getScreenHeight()

  Gets the current screen height.

  Specified by:

  getScreenHeight in interface IClientSessionGyro

  Returns:

  The current screen height, or zero if not initialized.

• getScreenSize

  public Size getScreenSize()

  Gets the current screen size.

  Specified by:

  getScreenSize in interface IClientSessionGyro

  Returns:

  The current screen size, zero width and/or height if not initialized.

• addScreenSizeListener

  public boolean addScreenSizeListener(IScreenSizeListener listener)

  Adds a screen size listener for the client session. Calling this method multiple times with the same listener will have no effect (but to return false).

  Specified by:

  addScreenSizeListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to add.

  Returns:

  true if the listener was added, false otherwise.

  Throws:

  NullPointerException - If the listener is null.

• removeScreenSizeListener

  public boolean removeScreenSizeListener(IScreenSizeListener listener)

  Removes a screen size listener for the client session.

  Specified by:

  removeScreenSizeListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to remove.

  Returns:

  true if listener is successfully removed, false otherwise.

• isScreenOrientationLockSupported

  public boolean isScreenOrientationLockSupported()

  Checks if screen orientation locking is supported or not.

  Specified by:

  isScreenOrientationLockSupported in interface IClientSessionGyro

  Returns:

  true if the functions to lock or unlock screen orientation are supported, false otherwise.

• addScreenOrientationListener

  public boolean addScreenOrientationListener(IScreenOrientationListener listener)

  Adds a screen orientation listener for the client session. Calling this method multiple times with the same listener will have no effect (but to return false).

  Specified by:

  addScreenOrientationListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to add.

  Returns:

  true if the listener was added, false otherwise.

  Throws:

  NullPointerException - If the listener is null.

• removeScreenOrientationListener

  public boolean removeScreenOrientationListener(IScreenOrientationListener listener)

  Removes a screen orientation listener for the client session.

  Specified by:

  removeScreenOrientationListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to remove.

  Returns:

  true if listener is successfully removed, false otherwise.

• getScreenOrientation

  public ScreenOrientation getScreenOrientation()

  Gets the current screen orientation.

  Specified by:

  getScreenOrientation in interface IClientSessionGyro

  Returns:

  The orientation, ScreenOrientation.unknown if not supported.

• setScreenOrientation

  public boolean setScreenOrientation(ScreenOrientation orientation)

  Locks the screen orientation.

  Note that there may be a delay in the orientation change after calling this method. This could be due to slow client connection, disconnected client or just due to device lag.

  Specified by:

  setScreenOrientation in interface IClientSessionGyro

  Parameters:

  orientation - The orientation.

  Returns:

  true for success, false for not supported.

  Throws:

  IllegalArgumentException - If orientation is ScreenOrientation.unknown.

• unlockScreenOrientation

  public boolean unlockScreenOrientation()

  Unlocks the screen orientation.

  Note that there may be a delay in the orientation change after calling this method. This could be due to slow client connection, disconnected client or just due to device lag.

  Specified by:

  unlockScreenOrientation in interface IClientSessionGyro

  Returns:

  true for success, false for not supported.

• getImage

  public RuntimeImageDefinition getImage(String name)

  Gets an image definition from the image container for the client session.

  Specified by:

  getImage in interface IRuntimeImageCache

  Parameters:

  name - The image name.

  Returns:

  The predefined image definition, or null if not found.

• setImage

  public boolean setImage(RuntimeImageDefinition image)

  Adds the image definition to the image container for the client session. If the image already exists, it is replaced with the new definition.

  Specified by:

  setImage in interface IRuntimeImageCache

  Parameters:

  image - The image definition.

  Returns:

  true if the container was changed, i.e. image was added or replaced, false for no change.

• removeImage

  public boolean removeImage(String name)

  Removes an image with a name from the client session.

  Specified by:

  removeImage in interface IRuntimeImageCache

  Parameters:

  name - The image to remove.

  Returns:

  true for removed, false if not found.

• clearImageCache

  public void clearImageCache()

  Clears the entire cache.

  Specified by:

  clearImageCache in interface IRuntimeImageCache

• getLocationService

  public ILocationService getLocationService()

  Returns an instance of the geolocation service.

  Specified by:

  getLocationService in interface IClientSessionGyro

  Returns:

  The instance, always non-null.

• sendStat

  public void sendStat(String event, DeviceParameter... params)

  Sends statistics event to the analytics engine on the client to log the event.

  Specified by:

  sendStat in interface IClientSessionGyro

  Parameters:

  event - The event name.

  params - Parameters to send, null values and sensitive parameters are ignored.

• getAnalyticsConsent

  public Boolean getAnalyticsConsent()

  Gets the user's Web Analytics consent as the client last reported it: the value of the EnvProps.PN_ANALYTICS_CONSENT boolean of this client's environment, set by a Browser client when its connection is established and again whenever the user decides.

  Never a cookie wall: the server may read this value, for example to decide what to log or to offer a privacy page, but no function of the application or of IIZI may ever depend on it. A user who declined must get exactly the same application as one who accepted.

  Specified by:

  getAnalyticsConsent in interface IClientSessionGyro

  Returns:

  Boolean.TRUE when accepted, Boolean.FALSE when declined, or null when undecided, when the client is not a Browser running an application with a Measurement ID (iiziRun, the Designer pages), or when it has not reported yet.

• askAnalyticsConsent

  public boolean askAnalyticsConsent()

  Asks the client to show IIZI's Web Analytics consent prompt now, even when a decision is already stored. The user's answer is written on the device, applied by the client without a page reload and reported back through getAnalyticsConsent(); this method does not wait for it.

  Only a Browser client running an application with a Measurement ID shows anything; iiziRun and the Designer pages ignore the request.

  Specified by:

  askAnalyticsConsent in interface IClientSessionGyro

  Returns:

  true when the request was sent, false when the session is disposed of.

• setAnalyticsConsent

  public boolean setAnalyticsConsent(boolean granted)

  Sets the user's Web Analytics consent directly, when the application asked the user itself (the App page's consent choice "the application asks"). The client writes the decision on the device, starts or stops Analytics accordingly without a page reload, and reports the new value back through getAnalyticsConsent(); this method does not wait for it.

  Only a Browser client running an application with a Measurement ID acts on it; iiziRun and the Designer pages ignore the request.

  Specified by:

  setAnalyticsConsent in interface IClientSessionGyro

  Parameters:

  granted - true when the user accepted, false when the user declined.

  Returns:

  true when the decision was sent, false when the session is disposed of.

• getWebEngineStatus

  public WebEngineStatus getWebEngineStatus()

  Gets the verdict on the web engine this client runs on: whether it still receives security updates, and since when it does not. The server computed it when this client session connected, from what the client says about itself, and computes it again at every reconnect. IIZI never refuses or restricts a client because of it; an application may apply a policy of its own.

  Specified by:

  getWebEngineStatus in interface IClientSessionGyro

  Returns:

  The verdict, never null: WebEngineStatus.Status.NOT_ASSESSED for a client that is neither Android nor iOS, and when no verdict was computed.

• showWebEngineWarning

  public boolean showWebEngineWarning()

  Shows the user IIZI's notice that the web engine of the device no longer receives security updates, now. For an application whose "Unpatched web engine" choice on the App page is "the application decides"; with "IIZI warns" the notice is shown when the client session connects, and this call shows it again. The notice never blocks the application, and this method does not wait for it.

  Specified by:

  showWebEngineWarning in interface IClientSessionGyro

  Returns:

  true when the notice was sent to the client, false when the engine is patched or not assessed, the choice on the App page is "never", or the session is disposed of.

• getUIModes

  public int getUIModes()

  Gets the appearance modes the application allows a client to show: the App page's "Appearance" choice (ModuleApp.getUIModes()), as read when this session was created and told to the client in $schemeModes (CC-THEME-CHOOSER-UI: the theme chooser component hides itself when one mode only is allowed).

  Specified by:

  getUIModes in interface IClientSessionGyro

  Returns:

  The modes allowed: UISchemes.MODES_BOTH, UISchemes.MODES_LIGHT or UISchemes.MODES_DARK.

• getUIScheme

  public UISchemes.Scheme getUIScheme()

  Gets the theme scheme this client shows: the family and the resolved mode, light or dark, as the client last reported it in uiScheme of its environment.

  Specified by:

  getUIScheme in interface IClientSessionGyro

  Returns:

  The scheme shown, or null when the client has not reported one.

• getUISchemeChoice

  public UISchemes.Scheme getUISchemeChoice()

  Gets the theme scheme this client was told to show, the mode as chosen (auto included), as the client last reported it in uiSchemeChoice of its environment.

  Specified by:

  getUISchemeChoice in interface IClientSessionGyro

  Returns:

  The choice, or null when the client has not reported one.

• setUIScheme

  public boolean setUIScheme(UISchemes.Family family, UISchemes.Mode mode)

  Sets the theme scheme of this client: the family, the mode, or both, sent as the $scheme client property that iz/uischeme.js applies, stores on the device (a Browser's storage, iiziRun's settings) and reports back.

  Specified by:

  setUIScheme in interface IClientSessionGyro

  Parameters:

  family - The family, or null to keep the client's family.

  mode - The mode, or null to keep the client's mode.

  Returns:

  true when sent, false when disposed of or unchanged since last sent.

  Throws:

  IllegalArgumentException - If both are null.

• setUIMode

  public boolean setUIMode(UISchemes.Mode mode)

  Sets the mode of this client's theme scheme, keeping its family.

  Specified by:

  setUIMode in interface IClientSessionGyro

  Parameters:

  mode - The mode.

  Returns:

  true when sent, false when disposed of or unchanged since last sent.

  Throws:

  IllegalArgumentException - If the mode is null.

• setUIFamily

  public boolean setUIFamily(UISchemes.Family family)

  Sets the family of this client's theme scheme, keeping its mode.

  Specified by:

  setUIFamily in interface IClientSessionGyro

  Parameters:

  family - The family.

  Returns:

  true when sent, false when disposed of or unchanged since last sent.

  Throws:

  IllegalArgumentException - If the family is null.

• addUISchemeListener

  public boolean addUISchemeListener(IUISchemeListener listener)

  Adds a theme scheme listener for this client session.

  Specified by:

  addUISchemeListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to add.

  Returns:

  true if the listener was added, false otherwise.

  Throws:

  NullPointerException - If the listener is null.

• removeUISchemeListener

  public boolean removeUISchemeListener(IUISchemeListener listener)

  Removes a theme scheme listener for this client session.

  Specified by:

  removeUISchemeListener in interface IClientSessionGyro

  Parameters:

  listener - The listener to remove.

  Returns:

  true if listener is successfully removed, false otherwise.

• credentialsAccepted

  public boolean credentialsAccepted(UIContainer form)

  Tells the client that the credentials the user typed in a form container were accepted, so that the password manager of the Browser offers to save them (CC-LOGIN-L10A2-APP-CORE, T1-070): the call of this client's environment, EnvProps.credentialsAccepted(UIContainer).

  Specified by:

  credentialsAccepted in interface IClientSessionGyro

  Parameters:

  form - The container holding the text fields of the credentials, as the client session has it.

  Returns:

  true when the signal was sent, false when the session or its environment is disposed of, or the client has not sent its environment yet.

  Throws:

  NullPointerException - If the container is null.

  IllegalArgumentException - If the container is not in the property tree of this client session.

• saveClientStorage

  public boolean saveClientStorage(DeviceParameter... params)

  Saves values in the client's storage for the current app (CC-CLIENT-STORAGE-V5): see IClientSessionGyro.saveClientStorage(DeviceParameter...). Possible states of an item on return are DeviceParameter.State.SUCCESS, DeviceParameter.State.UNAVAILABLE, DeviceParameter.State.NOT_FOUND or DeviceParameter.State.ENCRYPT_ERROR.

  Specified by:

  saveClientStorage in interface IClientSessionGyro

  Parameters:

  params - Items to save.

  Returns:

  true for success of at least one item, false otherwise.

• getClientStorage

  public boolean getClientStorage(DeviceParameter... params)

  Retrieves values from the client's storage for the current app (CC-CLIENT-STORAGE-V5): see IClientSessionGyro.getClientStorage(DeviceParameter...).

  Specified by:

  getClientStorage in interface IClientSessionGyro

  Parameters:

  params - The items to retrieve.

  Returns:

  true for success, false if the client's storage is not present.

• triggerRemoteOpenWindow

  public boolean triggerRemoteOpenWindow(String url, String target, WindowOptions options, IWindowCloseListener windowListener)

  Triggers opening of a browser window on the client.

  Specified by:

  triggerRemoteOpenWindow in interface IClientSessionGyro

  Parameters:

  url - The URL to open.

  target - The target, null for _blank.

  options - Options to use, null for "new tab" for a browser client.

  windowListener - Callback to listen to blocked or user close window, null for none. When "spawn mode" is used in the options, this parameter is ignored, i.e. as if set to null.

  Returns:

  true for success, false if the window cannot be opened because another window already is open or that the session is disposed of. In case of failure, any callback close listener will not be invoked.

• triggerRemoteCloseWindow

  public boolean triggerRemoteCloseWindow(boolean ignoreCallbackListener)

  Triggers closing of the window on the client that was opened with triggerRemoteOpenWindow.

  Specified by:

  triggerRemoteCloseWindow in interface IClientSessionGyro

  Parameters:

  ignoreCallbackListener - Flag to ignore calling a potential callback listener.

  Returns:

  true for success, false if no open window is present.

• restartRemoteClient

  public void restartRemoteClient()

  Restarts the remote client. This is done without asking anything: it will just restart the iiziRun or browser by disconnecting from server and reloading the page directly. For iiziRun Developer/Custom sessions, this will bring up that interface.

  Specified by:

  restartRemoteClient in interface IClientSessionGyro