Class TooltipOptions

    • Method Detail

      • tooltipVisibility

        public final Visibility tooltipVisibility()

        Determines whether or not the tooltip is visible.

        If the service returns an enum value that is not available in the current SDK version, tooltipVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tooltipVisibilityAsString().

        Returns:
        Determines whether or not the tooltip is visible.
        See Also:
        Visibility
      • tooltipVisibilityAsString

        public final String tooltipVisibilityAsString()

        Determines whether or not the tooltip is visible.

        If the service returns an enum value that is not available in the current SDK version, tooltipVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tooltipVisibilityAsString().

        Returns:
        Determines whether or not the tooltip is visible.
        See Also:
        Visibility
      • selectedTooltipType

        public final SelectedTooltipType selectedTooltipType()

        The selected type for the tooltip. Choose one of the following options:

        • BASIC: A basic tooltip.

        • DETAILED: A detailed tooltip.

        If the service returns an enum value that is not available in the current SDK version, selectedTooltipType will return SelectedTooltipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectedTooltipTypeAsString().

        Returns:
        The selected type for the tooltip. Choose one of the following options:

        • BASIC: A basic tooltip.

        • DETAILED: A detailed tooltip.

        See Also:
        SelectedTooltipType
      • selectedTooltipTypeAsString

        public final String selectedTooltipTypeAsString()

        The selected type for the tooltip. Choose one of the following options:

        • BASIC: A basic tooltip.

        • DETAILED: A detailed tooltip.

        If the service returns an enum value that is not available in the current SDK version, selectedTooltipType will return SelectedTooltipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectedTooltipTypeAsString().

        Returns:
        The selected type for the tooltip. Choose one of the following options:

        • BASIC: A basic tooltip.

        • DETAILED: A detailed tooltip.

        See Also:
        SelectedTooltipType
      • fieldBasedTooltip

        public final FieldBasedTooltip fieldBasedTooltip()

        The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

        Returns:
        The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)