Package com.zopim.android.sdk.api

Class ZopimChat.DefaultConfig

java.lang.Object

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

com.zopim.android.sdk.api.ZopimChat.DefaultConfig

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ZopimChat

public static class ZopimChat.DefaultConfig
extends ZopimChatApi.DefaultConfig<ZopimChat.DefaultConfig>

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 ZopimChat.SessionConfig configuration provided when starting a new chat.

See Also:

ZopimChat.SessionConfig, Serialized Form

Method Summary

Modifier and Type	Method and Description
T	department(java.lang.String department) Sets department to the configuration builder.
ZopimChat.DefaultConfig	disableVisitorInfoStorage() Disables VisitorInfoPrefsStorage storage.
ZopimChat.DefaultConfig	emailTranscript(EmailTranscript emailTranscript)
ZopimChat.DefaultConfig	fileSending(boolean enabled)
ZopimChat.DefaultConfig	initializationTimeout(long milliseconds) Sets chat initialization timeout.
ZopimChat.DefaultConfig	preChatForm(PreChatForm preChatForm)
ZopimChat.DefaultConfig	reconnectTimeout(long milliseconds) Sets the reconnect timeout.
ZopimChat.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 com.zopim.android.sdk.api.ZopimChatApi.DefaultConfig

build

Methods inherited from class java.lang.Object

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

Method Detail

preChatForm

public ZopimChat.DefaultConfig preChatForm(PreChatForm preChatForm)

emailTranscript

public ZopimChat.DefaultConfig emailTranscript(EmailTranscript emailTranscript)

fileSending

public ZopimChat.DefaultConfig fileSending(boolean enabled)

disableVisitorInfoStorage

public ZopimChat.DefaultConfig disableVisitorInfoStorage()

Description copied from class: ZopimChatApi.DefaultConfig

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

Overrides:

disableVisitorInfoStorage in class ZopimChatApi.DefaultConfig<ZopimChat.DefaultConfig>

Returns:

configuration builder

initializationTimeout

public ZopimChat.DefaultConfig initializationTimeout(long milliseconds)

Description copied from class: ZopimChatApi.DefaultConfig

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

Overrides:

initializationTimeout in class ZopimChatApi.DefaultConfig<ZopimChat.DefaultConfig>

Parameters:

milliseconds - after which chat initialization should timeout

Returns:

configuration builder

reconnectTimeout

public ZopimChat.DefaultConfig reconnectTimeout(long milliseconds)

Description copied from class: ZopimChatApi.DefaultConfig

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

Overrides:

reconnectTimeout in class ZopimChatApi.DefaultConfig<ZopimChat.DefaultConfig>

Parameters:

milliseconds - after which chat reconnect should timeout

Returns:

configuration builder

sessionTimeout

public ZopimChat.DefaultConfig sessionTimeout(long milliseconds)

Description copied from class: ZopimChatApi.DefaultConfig

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

Overrides:

sessionTimeout in class ZopimChatApi.DefaultConfig<ZopimChat.DefaultConfig>

Parameters:

milliseconds - after which chat session should timeout

Returns:

configuration builder

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