Package com.inductiveautomation.perspective.common.auth

Enum FramingOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FramingOption>
    public enum FramingOption
extends java.lang.Enum<FramingOption>
    An enumeration of the supported methods for presenting the authentication challenge UI

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FramingOption.GsonAdapter
      A JsonSerializer and JsonDeserializer implementation for serializing and de-serializing FramingOption objects to / from JSON using GSON APIs.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EMBEDDED
      Open the authentication UI within an embedded iframe
      NEW
      Open the authentication UI in a new tab / window
      SELF
      Open the authentication UI using the current tab / window

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static FramingOption fromJsonTree​(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement)
      Attempts to parse a FramingOption from a JsonElement
      static java.util.Optional<FramingOption> parse​(java.lang.String str)  
      com.inductiveautomation.ignition.common.gson.JsonElement toJsonTree()  
      static FramingOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FramingOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SELF

        public static final FramingOption SELF
        Open the authentication UI using the current tab / window

      • NEW

        public static final FramingOption NEW
        Open the authentication UI in a new tab / window

      • EMBEDDED

        public static final FramingOption EMBEDDED
        Open the authentication UI within an embedded iframe

    • Method Detail

      • values

        public static FramingOption[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FramingOption c : FramingOption.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FramingOption valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • parse

        public static java.util.Optional<FramingOption> parse​(@Nullable
                                                      java.lang.String str)
        Parameters:
        str - a string to parse into a FramingOption
        Returns:
        an Optional containing the FramingOption parsed from the provided string, or an empty Optional if the string is null or if the string could not be parsed into one of the FramingOptions

      • fromJsonTree

        public static FramingOption fromJsonTree​(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement)
        Attempts to parse a FramingOption from a JsonElement
        Parameters:
        jsonElement - the JsonElement to parse
        Returns:
        the FramingOption parsed from the provided JsonElement
        Throws:
        com.inductiveautomation.ignition.common.gson.JsonParseException - if a FramingOption cannot be parsed from the provided JsonElement
        See Also:
        parse(String)

      • toJsonTree

        public com.inductiveautomation.ignition.common.gson.JsonElement toJsonTree()
        Returns:
        this FramingOption as a JsonElement