Package com.iizix.device.settings

Interface IOpenNativeSettings

All Known Implementing Classes:
NativeSetting
public interface IOpenNativeSettings
Interface used to open native device settings when the client is iiziRun based.

The device settings opens native Android or iOS settings. This interface is only present on the Hybrid iiziRun based client (Cordova based) and is not available for other client types such as pure browser or Progressive Web Apps (PWA).

This interface is retrieved from the client session using IClientSessionGyro.getOpenNativeSettings(). The native setting is opened with the method openNativeSettings(INativeSetting, IOpenSettingSuccess, IOpenSettingFailure).

See cordova-open-native-settings of the implementation in Cordova for more information.

Author:
Christopher Mindus

  • Field Details

    • DEFAULT_IMPL

      static final IOpenNativeSettings DEFAULT_IMPL
      Default instance that always returns unsupported and not Android nor iOS client, and throws IllegalArgumentException when attempting to open a setting.

  • Method Details

    • isSupported

      boolean isSupported()
      Checks if this client supports any native settings or not.
      Returns:
      true if client is Android or iOS running iiziRun, false otherwise (e.g. browser or PWA).

    • isClient_Android

      boolean isClient_Android()
      Checks if the client is Android.
      Returns:
      true if client is Android running iiziRun, false otherwise (e.g. browser or PWA).

    • isClient_iOS

      boolean isClient_iOS()
      Checks if the client is iOS.
      Returns:
      true if client is iOS running iiziRun, false otherwise (e.g. browser or PWA).

    • isReady

      boolean isReady()
      Verifies if this instance is ready to accept an open native settings call. Please note that it is not guaranteed due to threading that the call to openNativeSettings(INativeSetting, IOpenSettingSuccess, IOpenSettingFailure) will succeed.
      Returns:
      true if the client supports opening a setting and that it is not busy, disconnected or not available to process requests.

    • getClientSession

      IClientSessionGyro getClientSession()
      Gets the client session associated with this flashlight instance.
      Returns:
      The client session, or null if it is disposed of already. Please note that the client session might be returned as non-null but that it is currently in dispose operation.

    • openNativeSettings

      boolean openNativeSettings(INativeSetting setting, IOpenSettingSuccess success, IOpenSettingFailure failure)
      Opens a native setting on the client. The success and failure parameters can be specified as a callbacks that receives two parameters: the client session that was the target of the open native setting, and the setting requested for the open operation. If either success or failure functions are null, it is accepted and just ignored by the API.
      Parameters:
      setting - The setting to open.
      success - Success callback function, null for none (ignored).
      failure - Failure callback function, null for none (ignored).
      Returns:
      Flag for successful request issued. When true, the callbacks (if defined) will be invoked at a later stage. If the request fails immediately and this return code is false, a potential failure callback will be invoked prior to returning, in the same thread.
      Throws:
      NullPointerException - If the setting is null.
      IllegalArgumentException - If the setting is not valid for the client device in question.