ai.tock.bot.connector

Class ConnectorData

ai.tock.bot.connector.ConnectorData

public class ConnectorData

The connector data that connector sends to the ConnectorController

See Also:

ConnectorController

Constructor Summary

Constructors

Constructor and Description
ConnectorData(ConnectorCallback callback, PlayerId priorUserId, boolean saveTimeline, java.lang.String groupId, java.lang.String referer) The connector data that connector sends to the ConnectorController

Method Summary

Modifier and Type	Method and Description
ConnectorCallback	getCallback() The callback
java.lang.String	getGroupId() An optional group id
PlayerId	getPriorUserId() The previous user id
java.lang.String	getReferer() An optional referer.
boolean	getSaveTimeline() To know if the timeline has to be saved
boolean	getSkipAnswer() Set to true if the bot does not make any answer to a user sentence. Synchronous interface Connectors usually do not support skipping answer.
void	setSkipAnswer(boolean p) Set to true if the bot does not make any answer to a user sentence. Synchronous interface Connectors usually do not support skipping answer.

Constructor Detail

ConnectorData

public ConnectorData(@NotNull
                     ConnectorCallback callback,
                     @Nullable
                     PlayerId priorUserId,
                     boolean saveTimeline,
                     @Nullable
                     java.lang.String groupId,
                     @Nullable
                     java.lang.String referer)

The connector data that connector sends to the ConnectorController

Parameters:

callback - The callback (used mostly in synchronous interface Connector).

priorUserId - The previous user id - used when the user had a "temporary" identifierand the definitive identifier is now known.

saveTimeline - To know if the timeline has to be saved - default is true.Set to false for bots that you don't need to register.

groupId - An optional group id (for users group conversation handling).

referer - An optional referer.

See Also:

ConnectorController

Method Detail

getSkipAnswer

public boolean getSkipAnswer()

Set to true if the bot does not make any answer to a user sentence. Synchronous interface Connectors usually do not support skipping answer.

See Also:

interface Connector

setSkipAnswer

public void setSkipAnswer(boolean p)

Set to true if the bot does not make any answer to a user sentence. Synchronous interface Connectors usually do not support skipping answer.

See Also:

interface Connector

getCallback

@NotNull
public ConnectorCallback getCallback()

The callback

(used mostly in synchronous interface Connector).

See Also:

interface Connector

getPriorUserId

@Nullable
public PlayerId getPriorUserId()

The previous user id

- used when the user had a "temporary" identifierand the definitive identifier is now known.

getSaveTimeline

public boolean getSaveTimeline()

To know if the timeline has to be saved

- default is true.Set to false for bots that you don't need to register.

getGroupId

@Nullable
public java.lang.String getGroupId()

An optional group id

(for users group conversation handling).

getReferer

@Nullable
public java.lang.String getReferer()

An optional referer.