Package zendesk.support

Enum Guide

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Guide>

    public enum Guide
extends java.lang.Enum<Guide>

    • Enum Constant Detail

      • INSTANCE

        public static final Guide INSTANCE

    • Method Detail

      • values

        public static Guide[] 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 (Guide c : Guide.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Guide 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

      • init

        public void init(Zendesk zendesk)
        Initialises the Guide SDK

        A lazy loading strategy is applied to all Provider calls to ensure that settings are always present before a call to Zendesk.

        Parameters:
        zendesk - The instance of zendesk to initialize Guide with

      • isInitialized

        public boolean isInitialized()
        Gets whether Guide.init(Zendesk) was called or not.
        Returns:
        true if init was successfully called, false otherwise.

      • setHelpCenterLocaleOverride

        public void setHelpCenterLocaleOverride(java.util.Locale locale)
        Set a locale override for Help Center content. By default, Help Center content will be requested in the locale of the device. Use this method to force a specific locale to be used when requesting Help Center content.

        Note that if you set a locale that is not supported on your Help Center, you will not receive any content.

        Parameters:
        locale - the locale to force in all requests to Help Center.

      • getHelpCenterLocaleOverride

        public java.util.Locale getHelpCenterLocaleOverride()
        Returns the override, if any, for the locale to be used in Help Center requests. If no override has been set, the device locale will be used.
        Returns:
        the locale override, or null if no override has been set.