ConversationReference Class

Package:
com.microsoft.bot.schema
Maven Artifact:
com.microsoft.bot:bot-schema:4.14.3
  • java.lang.Object
    • com.microsoft.bot.schema.ConversationReference

public class ConversationReference

An object relating to a particular point in a conversation.

Constructor Summary

Constructor Description
ConversationReference()

Method Summary

Modifier and Type Method and Description
static ConversationReference clone(ConversationReference conversationReference)

Performs a deep copy of a ConversationReference.
java.lang.String getActivityId()

(Optional) ID of the activity to refer to.
ChannelAccount getBot()

Bot participating in this conversation.
java.lang.String getChannelId()

Get the channelId value.
Activity getContinuationActivity()

Creates Activity from conversation reference as it is posted to bot.
ConversationAccount getConversation()

Conversation reference.
java.lang.String getLocale()

Get the locale value.
java.lang.String getServiceUrl()

Service endpoint where operations concerning the referenced conversation may be performed.
ChannelAccount getUser()

(Optional) User participating in this conversation.
void setActivityId(String withActivityId)

(Optional) ID of the activity to refer to.
void setBot(ChannelAccount withBot)

Bot participating in this conversation.
void setChannelId(String withChannelId)

Set the channelId value.
void setConversation(ConversationAccount withConversation)

Conversation reference.
void setLocale(String withLocale)

Set the locale value.
void setServiceUrl(String withServiceUrl)

Service endpoint where operations concerning the referenced conversation may be performed.
void setUser(ChannelAccount withUser)

(Optional) User participating in this conversation.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ConversationReference

public ConversationReference()

Method Details

clone

public static ConversationReference clone(ConversationReference conversationReference)

Performs a deep copy of a ConversationReference.

Parameters:

conversationReference - The ConversationReference to copy.

Returns:

A clone of the ConversationReference.

getActivityId

public String getActivityId()

(Optional) ID of the activity to refer to.

Returns:

the activityId value

getBot

public ChannelAccount getBot()

Bot participating in this conversation.

Returns:

the bot value

getChannelId

public String getChannelId()

Get the channelId value.

Returns:

the channelId value

getContinuationActivity

public Activity getContinuationActivity()

Creates Activity from conversation reference as it is posted to bot.

Returns:

A continuation activity.

getConversation

public ConversationAccount getConversation()

Conversation reference.

Returns:

the conversation value

getLocale

public String getLocale()

Get the locale value.

Returns:

the locale value

getServiceUrl

public String getServiceUrl()

Service endpoint where operations concerning the referenced conversation may be performed.

Returns:

the serviceUrl value

getUser

public ChannelAccount getUser()

(Optional) User participating in this conversation.

Returns:

the user value

setActivityId

public void setActivityId(String withActivityId)

(Optional) ID of the activity to refer to.

Parameters:

withActivityId - the activityId value to set

setBot

public void setBot(ChannelAccount withBot)

Bot participating in this conversation.

Parameters:

withBot - the bot value to set

setChannelId

public void setChannelId(String withChannelId)

Set the channelId value.

Parameters:

withChannelId - the channelId value to set

setConversation

public void setConversation(ConversationAccount withConversation)

Conversation reference.

Parameters:

withConversation - the conversation value to set

setLocale

public void setLocale(String withLocale)

Set the locale value.

Parameters:

withLocale - the locale value to set

setServiceUrl

public void setServiceUrl(String withServiceUrl)

Service endpoint where operations concerning the referenced conversation may be performed.

Parameters:

withServiceUrl - the serviceUrl value to set

setUser

public void setUser(ChannelAccount withUser)

(Optional) User participating in this conversation.

Parameters:

withUser - the user value to set

Applies to