Package com.iizix.device.settings

Enum Class CommonSettings

java.lang.Object
java.lang.Enum<CommonSettings>
com.iizix.device.settings.CommonSettings
All Implemented Interfaces:
INativeSetting, Serializable, Comparable<CommonSettings>, Constable
public enum CommonSettings extends Enum<CommonSettings> implements INativeSetting
Common native settings for Android and iOS that are potentially openable on the client device using the IOpenNativeSettings interface. This interface is retrieved from the client session using IClientSessionGyro.getOpenNativeSettings(). The setting in question is then opened using the interface method IOpenNativeSettings.openNativeSettings(INativeSetting, IOpenSettingSuccess, IOpenSettingFailure).
Author:
Christopher Mindus

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AppSettings
    Show screen of details about the application (Android) -- Application Settings (iOS).
    Battery
    Show screen for controlling which apps can ignore battery optimizations (Android) -- Show Settings > Battery (iOS).
    Biometric
    Show screen for configuring biometric based device security (Android) -- Show Settings > Touch ID/Face ID & Passcode (iOS).
    Bluetooth
    Show settings to allow configuration of Bluetooth (Anroid) -- Show Settings > Bluetooth (iOS).
    Date
    Show settings to allow configuration of date and time (Android) -- Show Settings > General > Date & Time (iOS).
    Keyboard
    Show settings to configure input methods, in particular allowing the user to enable input methods (Android) -- Show Settings > General > Keyboard (iOS).
    Keyboards
    Show settings to enable/disable input method subtypes (Android) -- Show Settings > General > Keyboard > Keyboards (iOS).
    Locale
    Show settings to allow configuration of locale (Android) -- Show Settings > General > Language & Region (iOS).
    Locations
    Show settings to allow configuration of current location sources (Android) -- Show Settings > Privacy > Location Services (iOS).
    Notifications
    Show Settings > Notifications (on both Android and iOS).
    Search
    Show settings for global search (Android) -- show Settings > Siri (iOS).
    Settings
    Show system settings (Android) -- show Settings > General (iOS).
    Sound
    Show settings to allow configuration of sound and volume (Android) -- show Settings > Sounds (iOS).
    Store
    Open the Play Store page of the current application (Android) -- Show Settings > App Store (iOS).
    WiFi
    Show settings to allow configuration of Wi-Fi (Android) -- show Settings > Wi-Fi (iOS).

  • Field Summary

    Fields inherited from interface com.iizix.device.settings.INativeSetting

    TYPE_Android, TYPE_BOTH, TYPE_iOS

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getNativeOp_Android()
    Gets the internal setting name to use on the native Android client device.
    String
    getNativeOp_iOS()
    Gets the internal setting name to use on the native iOS client device.
    int
    getType()
    Checks if the setting is for Android, iOS or both.
    String
    toString()
    The string representation of the enum as "com.iizix.device.settings.CommonSettings[nativeOp]", where "nativeOp" is a string for the native operation when both Android and iOS use the same value, otherwise the string will be "Android=nativeOp_Android,iOS=nativeOp_iOS".
    static CommonSettings
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CommonSettings[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AppSettings

      public static final CommonSettings AppSettings
      Show screen of details about the application (Android) -- Application Settings (iOS).

    • Battery

      public static final CommonSettings Battery
      Show screen for controlling which apps can ignore battery optimizations (Android) -- Show Settings > Battery (iOS).

    • Biometric

      public static final CommonSettings Biometric
      Show screen for configuring biometric based device security (Android) -- Show Settings > Touch ID/Face ID & Passcode (iOS).

    • Bluetooth

      public static final CommonSettings Bluetooth
      Show settings to allow configuration of Bluetooth (Anroid) -- Show Settings > Bluetooth (iOS).

    • Date

      public static final CommonSettings Date
      Show settings to allow configuration of date and time (Android) -- Show Settings > General > Date & Time (iOS).

    • Keyboard

      public static final CommonSettings Keyboard
      Show settings to configure input methods, in particular allowing the user to enable input methods (Android) -- Show Settings > General > Keyboard (iOS).

    • Keyboards

      public static final CommonSettings Keyboards
      Show settings to enable/disable input method subtypes (Android) -- Show Settings > General > Keyboard > Keyboards (iOS).

    • Locale

      public static final CommonSettings Locale
      Show settings to allow configuration of locale (Android) -- Show Settings > General > Language & Region (iOS).

    • Locations

      public static final CommonSettings Locations
      Show settings to allow configuration of current location sources (Android) -- Show Settings > Privacy > Location Services (iOS).

    • Notifications

      public static final CommonSettings Notifications
      Show Settings > Notifications (on both Android and iOS).

    • Settings

      public static final CommonSettings Settings
      Show system settings (Android) -- show Settings > General (iOS).

    • Sound

      public static final CommonSettings Sound
      Show settings to allow configuration of sound and volume (Android) -- show Settings > Sounds (iOS).

    • Store

      public static final CommonSettings Store
      Open the Play Store page of the current application (Android) -- Show Settings > App Store (iOS).

    • WiFi

      public static final CommonSettings WiFi
      Show settings to allow configuration of Wi-Fi (Android) -- show Settings > Wi-Fi (iOS).

  • Method Details

    • values

      public static CommonSettings[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CommonSettings valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getType

      public int getType()
      Checks if the setting is for Android, iOS or both.
      Specified by:
      getType in interface INativeSetting
      Returns:
      The value INativeSetting.TYPE_BOTH.

    • getNativeOp_Android

      public String getNativeOp_Android()
      Gets the internal setting name to use on the native Android client device.
      Specified by:
      getNativeOp_Android in interface INativeSetting
      Returns:
      An internal String value that should not be used, null if not available for the device type.

    • getNativeOp_iOS

      public String getNativeOp_iOS()
      Gets the internal setting name to use on the native iOS client device.
      Specified by:
      getNativeOp_iOS in interface INativeSetting
      Returns:
      An internal String value that should not be used, null if not available for the device type.

    • toString

      public String toString()
      The string representation of the enum as "com.iizix.device.settings.CommonSettings[nativeOp]", where "nativeOp" is a string for the native operation when both Android and iOS use the same value, otherwise the string will be "Android=nativeOp_Android,iOS=nativeOp_iOS".
      Overrides:
      toString in class Enum<CommonSettings>
      Returns:
      The string formatted as "com.iizix.device.settings.CommonSettings[nativeOp]" when the "nativeOp" for both Android and iOS are the same, otherwise "com.iizix.device.settings.CommonSettings[Android=nativeOp_Android,iOS=nativeOp_iOS]"