Package com.zopim.android.sdk.api

Class ZopimChatApi.DefaultConfig<T extends ZopimChatApi.DefaultConfig>

java.lang.Object

com.zopim.android.sdk.api.ZopimChatApi.DefaultConfig<T>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ZopimChat.DefaultConfig

Enclosing class:

ZopimChatApi

public static class ZopimChatApi.DefaultConfig<T extends ZopimChatApi.DefaultConfig>
extends java.lang.Object

Configuration class for global chat configuration

Configuration specified here will be applicable to all chat sessions that get started. This configuration can be overridden by a ZopimChatApi.SessionConfig configuration provided when starting a new chat.

See Also:

ZopimChatApi.SessionConfig, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultConfig()

Method Summary

Modifier and Type	Method and Description
java.lang.Void	build() Deprecated. As of release 1.2, calling build is not required.
T	department(java.lang.String department) Sets department to the configuration builder.
ZopimChatApi.DefaultConfig	disableVisitorInfoStorage() Disables VisitorInfoPrefsStorage storage.
ZopimChatApi.DefaultConfig	initializationTimeout(long milliseconds) Sets chat initialization timeout.
ZopimChatApi.DefaultConfig	reconnectTimeout(long milliseconds) Sets the reconnect timeout.
ZopimChatApi.DefaultConfig	sessionTimeout(long milliseconds) Sets chat session timeout.
T	tags(java.lang.String... tags) Sets tags to the configuration builder.
T	visitorPathOne(java.lang.String visitorPath) Sets visitor path as additional info visible in the Zopim chat dashboard.
T	visitorPathTwo(java.lang.String visitorPath) Sets visitor path as additional info visible in the Zopim chat dashboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfig

public DefaultConfig()

Method Detail

disableVisitorInfoStorage

public ZopimChatApi.DefaultConfig disableVisitorInfoStorage()

Disables VisitorInfoPrefsStorage storage. Configured VisitorInfo will not be stored for later reuse.

Returns:

configuration builder

initializationTimeout

public ZopimChatApi.DefaultConfig initializationTimeout(long milliseconds)

Sets chat initialization timeout. If chat fails to initialize in this time it will broadcast an intent with action ChatSession.ACTION_CHAT_INITIALIZATION_TIMEOUT

Parameters:

milliseconds - after which chat initialization should timeout

Returns:

configuration builder

reconnectTimeout

public ZopimChatApi.DefaultConfig reconnectTimeout(long milliseconds)

Sets the reconnect timeout. This configures the connection retry timeout used in the UI

Parameters:

milliseconds - after which chat reconnect should timeout

Returns:

configuration builder

sessionTimeout

public ZopimChatApi.DefaultConfig sessionTimeout(long milliseconds)

Sets chat session timeout. This configures the time after which the chat will timeout and disconnect if no further visitor message has been sent.

Parameters:

milliseconds - after which chat session should timeout

Returns:

configuration builder

build

@Deprecated
public java.lang.Void build()

Deprecated. As of release 1.2, calling build is not required.

Saves the global chat configuration that will be available to all chat sessions.

department

public T department(java.lang.String department)

Sets department to the configuration builder. Department will be visible in the Zopim chat dashboard.

Parameters:

department - name

Returns:

configuration builder

tags

public T tags(java.lang.String... tags)

Sets tags to the configuration builder. Tags will be visible in the Zopim chat dashboard.

Parameters:

tags - for the chat

Returns:

configuration builder

visitorPathOne

public T visitorPathOne(java.lang.String visitorPath)

Sets visitor path as additional info visible in the Zopim chat dashboard.

Additional information configured in the dashboard used to help identify the origin of the chat.

Parameters:

visitorPath - as extra info visible on the dashboard

Returns:

configuration builder

visitorPathTwo

public T visitorPathTwo(java.lang.String visitorPath)

Sets visitor path as additional info visible in the Zopim chat dashboard.

Additional information configured in the dashboard used to help identify the origin of the chat.

Parameters:

visitorPath - as extra info visible on the dashboard

Returns:

configuration builder