Package zendesk.chat

Class ChatProvidersConfiguration

java.lang.Object

zendesk.chat.ChatProvidersConfiguration

public class ChatProvidersConfiguration
extends java.lang.Object

Default configuration used when starting chats from this SDK. Sample usage: To set a department where chats will be routed by default;

 Chat.INSTANCE.setChatProvidersConfiguration(
    ChatProvidersConfiguration
       .builder(Chat.INSTANCE.getChatProvidersConfiguration())
       .withDepartment("Support"))
       .build()
 

To set information about the visitor that will be included in the next chat;

 Chat.INSTANCE.setChatProvidersConfiguration(
    ChatProvidersConfiguration
       .builder(Chat.INSTANCE.getChatProvidersConfiguration())
       .withVisitorInfo(
          VisitorInfo
             .builder()
             .withEmail("user@testemail.com")
             .build())
       .build()
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChatProvidersConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ChatProvidersConfiguration.Builder	builder() Returns a builder for constructing an instances of ChatProvidersConfiguration.
static ChatProvidersConfiguration.Builder	builder(ChatProvidersConfiguration chatProvidersConfiguration) Returns a builder for constructing an instances of ChatProvidersConfiguration that builds on top of an existing visitor info.
java.lang.String	getDepartmentName() Returns the default department of this chat.
VisitorInfo	getVisitorInfo() Returns the zendesk.chat.VisitorInfo of this user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVisitorInfo

public VisitorInfo getVisitorInfo()

Returns the zendesk.chat.VisitorInfo of this user. Will return an empty zendesk.chat.VisitorInfo object if not set.

Returns:

zendesk.chat.VisitorInfo object.

getDepartmentName

public java.lang.String getDepartmentName()

Returns the default department of this chat. Will return null if not set.

Returns:

String value of default department.

builder

public static ChatProvidersConfiguration.Builder builder()

Returns a builder for constructing an instances of ChatProvidersConfiguration.

See Also:

zendesk.chat.VisitorInfo.Builder

builder

public static ChatProvidersConfiguration.Builder builder(ChatProvidersConfiguration chatProvidersConfiguration)

Returns a builder for constructing an instances of ChatProvidersConfiguration that builds on top of an existing visitor info.

See Also:

ChatProvidersConfiguration.Builder, ChatProvidersConfiguration