SkillDialogOptions Class

Package:
com.microsoft.bot.dialogs
Maven Artifact:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.SkillDialogOptions

public class SkillDialogOptions

Defines the options that will be used to execute a SkillDialog .

Constructor Summary

Constructor Description
SkillDialogOptions()

Method Summary

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

Gets the Microsoft app ID of the bot calling the skill.
java.lang.String getConnectionName()

Gets the OAuth Connection Name, that would be used to perform Single SignOn with a skill.
SkillConversationIdFactoryBase getConversationIdFactory()

Gets an instance of a SkillConversationIdFactoryBase used to generate conversation IDs for interacting with the skill.
ConversationState getConversationState()

Gets the ConversationState to be used by the dialog.
BotFrameworkSkill getSkill()

Gets the BotFrameworkSkill that the dialog will call.
BotFrameworkClient getSkillClient()

Gets the BotFrameworkClient used to call the remote skill.
java.net.URI getSkillHostEndpoint()

Gets the callback Url for the skill host.
void setBotId(String withBotId)

Sets the Microsoft app ID of the bot calling the skill.
void setConnectionName(String withConnectionName)

Sets the OAuth Connection Name, that would be used to perform Single SignOn with a skill.
void setConversationIdFactory(SkillConversationIdFactoryBase withConversationIdFactory)

Sets an instance of a SkillConversationIdFactoryBase used to generate conversation IDs for interacting with the skill.
void setConversationState(ConversationState withConversationState)

Sets the ConversationState to be used by the dialog.
void setSkill(BotFrameworkSkill withSkill)

Sets the BotFrameworkSkill that the dialog will call.
void setSkillClient(BotFrameworkClient withSkillClient)

Sets the BotFrameworkClient used to call the remote skill.
void setSkillHostEndpoint(URI withSkillHostEndpoint)

Sets the callback Url for the skill host.

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

SkillDialogOptions

public SkillDialogOptions()

Method Details

getBotId

public String getBotId()

Gets the Microsoft app ID of the bot calling the skill.

Returns:

the BotId value as a String.

getConnectionName

public String getConnectionName()

Gets the OAuth Connection Name, that would be used to perform Single SignOn with a skill.

Returns:

the ConnectionName value as a String.

getConversationIdFactory

public SkillConversationIdFactoryBase getConversationIdFactory()

Gets an instance of a SkillConversationIdFactoryBase used to generate conversation IDs for interacting with the skill.

Returns:

the ConversationIdFactory value as a SkillConversationIdFactoryBase.

getConversationState

public ConversationState getConversationState()

Gets the ConversationState to be used by the dialog.

Returns:

the ConversationState value as a getConversationState().

getSkill

public BotFrameworkSkill getSkill()

Gets the BotFrameworkSkill that the dialog will call.

Returns:

the Skill value as a BotFrameworkSkill.

getSkillClient

public BotFrameworkClient getSkillClient()

Gets the BotFrameworkClient used to call the remote skill.

Returns:

the SkillClient value as a BotFrameworkClient.

getSkillHostEndpoint

public URI getSkillHostEndpoint()

Gets the callback Url for the skill host.

Returns:

the SkillHostEndpoint value as a Uri.

setBotId

public void setBotId(String withBotId)

Sets the Microsoft app ID of the bot calling the skill.

Parameters:

withBotId - The BotId value.

setConnectionName

public void setConnectionName(String withConnectionName)

Sets the OAuth Connection Name, that would be used to perform Single SignOn with a skill.

Parameters:

withConnectionName - The ConnectionName value.

setConversationIdFactory

public void setConversationIdFactory(SkillConversationIdFactoryBase withConversationIdFactory)

Sets an instance of a SkillConversationIdFactoryBase used to generate conversation IDs for interacting with the skill.

Parameters:

withConversationIdFactory - The ConversationIdFactory value.

setConversationState

public void setConversationState(ConversationState withConversationState)

Sets the ConversationState to be used by the dialog.

Parameters:

withConversationState - The ConversationState value.

setSkill

public void setSkill(BotFrameworkSkill withSkill)

Sets the BotFrameworkSkill that the dialog will call.

Parameters:

withSkill - The Skill value.

setSkillClient

public void setSkillClient(BotFrameworkClient withSkillClient)

Sets the BotFrameworkClient used to call the remote skill.

Parameters:

withSkillClient - The SkillClient value.

setSkillHostEndpoint

public void setSkillHostEndpoint(URI withSkillHostEndpoint)

Sets the callback Url for the skill host.

Parameters:

withSkillHostEndpoint - The SkillHostEndpoint value.

Applies to