org.msbotframework4j.connector

Interface BotConnectorClient

public interface BotConnectorClient

BotConnector client interfaces. Might be used to asynchronously communicate with users.

Author:

Maksim Kanev

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_ENDPOINT

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<BotData>	getConversationData(String botId, String conversationId) Get the BotData record for the conversation
com.google.common.base.Optional<BotData>	getPerUserConversationData(String botId, String conversationId, String userId) Get the BotData record for the user in the conversation
com.google.common.base.Optional<BotData>	getUserData(String botId, String userId) Get the BotData record for the user
com.google.common.base.Optional<Message>	sendMessage(Message message) Initiate a new conversation with the user.
com.google.common.base.Optional<BotData>	setConversationData(String botId, String conversationId, BotData data) Update the bot conversation data
com.google.common.base.Optional<BotData>	setPerUserConversationData(String botId, String conversationId, String userId, BotData data) Update the bot user in a conversation data
com.google.common.base.Optional<BotData>	setUserData(String botId, String userId, BotData data) Update the bot user data

Field Detail

API_ENDPOINT

static final String API_ENDPOINT

See Also:

Constant Field Values

Method Detail

getUserData

com.google.common.base.Optional<BotData> getUserData(String botId,
                                                     String userId)

Get the BotData record for the user

Parameters:

botId - the BotId

userId - the UserId

Returns:

optional BotData object

setUserData

com.google.common.base.Optional<BotData> setUserData(String botId,
                                                     String userId,
                                                     BotData data)

Update the bot user data

Parameters:

botId - the BotId

userId - the UserId

data - the new BotData

Returns:

optional BotData object

getConversationData

com.google.common.base.Optional<BotData> getConversationData(String botId,
                                                             String conversationId)

Get the BotData record for the conversation

Parameters:

botId - the BotId

conversationId - the ConversationId

Returns:

optional BotData object

setConversationData

com.google.common.base.Optional<BotData> setConversationData(String botId,
                                                             String conversationId,
                                                             BotData data)

Update the bot conversation data

Parameters:

botId - the BotId

conversationId - the ConversationId

data - the new BotData

Returns:

optional BotData object

getPerUserConversationData

com.google.common.base.Optional<BotData> getPerUserConversationData(String botId,
                                                                    String conversationId,
                                                                    String userId)

Get the BotData record for the user in the conversation

Parameters:

botId - the BotId

conversationId - the ConversationId

userId - the UserId

Returns:

optional BotData object

setPerUserConversationData

com.google.common.base.Optional<BotData> setPerUserConversationData(String botId,
                                                                    String conversationId,
                                                                    String userId,
                                                                    BotData data)

Update the bot user in a conversation data

Parameters:

botId - the BotId

conversationId - the ConversationId

userId - the UserId

data - the new BotData

Returns:

optional BotData object

sendMessage

com.google.common.base.Optional<Message> sendMessage(Message message)

Initiate a new conversation with the user. The important fields are From, To, Text and Language.

Parameters:

message - the message that will initiate a conversation

Returns:

optional message object