Package zendesk.chat

Enum Chat

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

    public enum Chat
extends java.lang.Enum<Chat>
    A centralized entry point into Zendesk Chat SDK.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      INSTANCE 

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void clearCache() 
      void init(Context context, java.lang.String accountKey)
      Initializes the Chat SDK.
      void init(Context context, java.lang.String accountKey, java.lang.String appId)
      Initializes the Chat SDK with app id.
      Providers providers()
      Exposes access to all available providers within the Zendesk Chat SDK.
      void resetIdentity()
      Resets the visitor configuration to a clean slate allowing a new visitor to chat
      static Chat valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Chat[] 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

      • INSTANCE

        public static final Chat INSTANCE

    • Method Detail

      • values

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

      • valueOf

        public static Chat 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(Context context,
                 java.lang.String accountKey)
        Initializes the Chat SDK.

        Call this method in your Application#onCreate().

        Parameters:
        context - context, used to access Android framework APIs
        accountKey - your account key obtained from the web dashboard

      • init

        public void init(Context context,
                 java.lang.String accountKey,
                 java.lang.String appId)
        Initializes the Chat SDK with app id.

        Call this method in your Application#onCreate().

        Parameters:
        context - context, used to access Android framework APIs
        accountKey - your account key obtained from the web dashboard
        appId - your id for your application

      • providers

        public Providers providers()
        Exposes access to all available providers within the Zendesk Chat SDK.

        Make sure to call Chat.init(Context, String) first.

        Returns:
        Providers or null if Chat has not been initialized.

      • resetIdentity

        public void resetIdentity()
        Resets the visitor configuration to a clean slate allowing a new visitor to chat

        Any ongoing chat will be ended, and locally stored information about the visitor will be cleared

      • clearCache

        public void clearCache()