TokenExchangeState Class

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

public class TokenExchangeState

State object passed to the bot token service.

Constructor Summary

Constructor Description
TokenExchangeState()

Method Summary

Modifier and Type Method and Description
java.lang.String getBotUrl()

The URL of the bot messaging endpoint.
java.lang.String getConnectionName()

The connection name that was used.
ConversationReference getConversation()

A reference to the conversation.
java.lang.String getMsAppId()

The bot's registered application ID.
ConversationReference getRelatesTo()

Gets the reference to a related parent conversation for this token exchange.
void setBotUrl(String withBotUrl)

The URL of the bot messaging endpoint.
void setConnectionName(String withConnectionName)

The connection name that was used.
void setConversation(ConversationReference withConversation)

A reference to the conversation.
void setMsAppId(String withMsAppId)

The bot's registered application ID.
void setRelatesTo(ConversationReference withRelatesTo)

Sets the reference to a related parent conversation for this token exchange.

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

TokenExchangeState

public TokenExchangeState()

Method Details

getBotUrl

public String getBotUrl()

The URL of the bot messaging endpoint.

Returns:

The messaging endpoint.

getConnectionName

public String getConnectionName()

The connection name that was used.

Returns:

The connection name.

getConversation

public ConversationReference getConversation()

A reference to the conversation.

Returns:

The conversation reference.

getMsAppId

public String getMsAppId()

The bot's registered application ID.

Returns:

The app id.

getRelatesTo

public ConversationReference getRelatesTo()

Gets the reference to a related parent conversation for this token exchange.

Returns:

A reference to a related parent conversation.

setBotUrl

public void setBotUrl(String withBotUrl)

The URL of the bot messaging endpoint.

Parameters:

withBotUrl - The messaging endpoint.

setConnectionName

public void setConnectionName(String withConnectionName)

The connection name that was used.

Parameters:

withConnectionName - The connection name.

setConversation

public void setConversation(ConversationReference withConversation)

A reference to the conversation.

Parameters:

withConversation - The conversation reference.

setMsAppId

public void setMsAppId(String withMsAppId)

The bot's registered application ID.

Parameters:

withMsAppId - The app id.

setRelatesTo

public void setRelatesTo(ConversationReference withRelatesTo)

Sets the reference to a related parent conversation for this token exchange.

Parameters:

withRelatesTo - A reference to a related parent conversation.

Applies to