SkillConversationIdFactoryBase Class

Package:
com.microsoft.bot.builder.skills
Maven Artifact:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.skills.SkillConversationIdFactoryBase

public abstract class SkillConversationIdFactoryBase

Defines the interface of a factory that is used to create unique conversation IDs for skill conversations.

Constructor Summary

Constructor Description
SkillConversationIdFactoryBase()

Method Summary

Modifier and Type Method and Description
java.util.concurrent.CompletableFuture<java.lang.String> createSkillConversationId(SkillConversationIdFactoryOptions options)

Creates a conversation id for a skill conversation.
java.util.concurrent.CompletableFuture<java.lang.String> createSkillConversationId(ConversationReference conversationReference)

Creates a conversation ID for a skill conversation super.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteConversationReference(String skillConversationId)

Deletes a ConversationReference .
java.util.concurrent.CompletableFuture<ConversationReference> getConversationReference(String skillConversationId)

Gets the ConversationReference created using {@link CreateSkillConversationId(Microsoft#getBot()#getSchema()#getConversatio Reference(),System#getThreading()#getCancellationToken())} for a skillConversationId.
java.util.concurrent.CompletableFuture<SkillConversationReference> getSkillConversationReference(String skillConversationId)

Gets the SkillConversationReference used during {@link CreateSkillConversationId(SkillConversationIdFactoryOptions,System#getT reading()#getCancellationToken())} for a skillConversationId.

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

SkillConversationIdFactoryBase

public SkillConversationIdFactoryBase()

Method Details

createSkillConversationId

public CompletableFuture createSkillConversationId(SkillConversationIdFactoryOptions options)

Creates a conversation id for a skill conversation.

Parameters:

options - A SkillConversationIdFactoryOptions instance containing parameters for creating the conversation ID.

Returns:

A unique conversation ID used to communicate with the skill. It should be possible to use the returned String on a request URL and it should not contain special characters.

createSkillConversationId

public CompletableFuture createSkillConversationId(ConversationReference conversationReference)

Creates a conversation ID for a skill conversation super. on the caller's ConversationReference .

Parameters:

conversationReference - The skill's caller ConversationReference .

Returns:

A unique conversation ID used to communicate with the skill. It should be possible to use the returned String on a request URL and it should not contain special characters.

deleteConversationReference

public abstract CompletableFuture deleteConversationReference(String skillConversationId)

Deletes a ConversationReference .

Parameters:

skillConversationId - A skill conversationId created using {@link CreateSkillConversationId(SkillConversationIdFactoryOptions,System#getT reading()#getCancellationToken())} .

Returns:

A CompletableFuture representing the asynchronous operation.

getConversationReference

public CompletableFuture getConversationReference(String skillConversationId)

Gets the ConversationReference created using {@link CreateSkillConversationId(Microsoft#getBot()#getSchema()#getConversatio Reference(),System#getThreading()#getCancellationToken())} for a skillConversationId.

Parameters:

skillConversationId - A skill conversationId created using {@link CreateSkillConversationId(Microsoft#getBot()#getSchema()#getConversatio Reference(),System#getThreading()#getCancellationToken())} .

Returns:

The caller's ConversationReference for a skillConversationId. null if not found.

getSkillConversationReference

public CompletableFuture getSkillConversationReference(String skillConversationId)

Gets the SkillConversationReference used during {@link CreateSkillConversationId(SkillConversationIdFactoryOptions,System#getT reading()#getCancellationToken())} for a skillConversationId.

Parameters:

skillConversationId - A skill conversationId created using {@link CreateSkillConversationId(SkillConversationIdFactoryOptions,System#getT reading()#getCancellationToken())} .

Returns:

The caller's ConversationReference for a skillConversationId, with originatingAudience. Null if not found.

Applies to