Skip to content
This repository was archived by the owner on Dec 4, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,5 @@ libraries/swagger/generated
/.vs/slnx.sqlite
/.vs/botbuilder-java/v16/.suo
/.vs/ProjectSettings.json
/.vs/botbuilder-java/v16/TestStore/0/000.testlog
/.vs/botbuilder-java/v16/TestStore/0/testlog.manifest
Original file line number Diff line number Diff line change
Expand Up @@ -731,9 +731,9 @@ protected CompletableFuture<QnAMakerClient> getQnAMakerClient(DialogContext dc)
* Gets the options for the QnA Maker client that the dialog will use to query
* the knowledge base.
*
* @param dc The <see cref="DialogContext"/> for the current turn of
* @param dc The {@link "DialogContext"} for the current turn of
* conversation.
* @return A <see cref="Task"/> representing the asynchronous operation. If the
* @return A {@link "Task"} representing the asynchronous operation. If the
* task is successful, the result contains the QnA Maker options to use.
*/
protected CompletableFuture<QnAMakerOptions> getQnAMakerOptions(DialogContext dc) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -636,8 +636,8 @@ protected CompletableFuture<Void> onInstallationUpdateRemove(TurnContext turnCon
*
* @return A task that represents the work queued to execute.
*
* When the {@link OnInvokeActivity(TurnContext{InvokeActivity})} method
* receives an Invoke with a {@link InvokeActivity#name} of
* When the {@link OnInvokeActivity(TurnContext(InvokeActivity))} method
* receives an Invoke with a {@link InvokeActivity.name} of
* `adaptiveCard/action`, it calls this method.
*/
protected CompletableFuture<AdaptiveCardInvokeResponse> onAdaptiveCardInvoke(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* <p>
* Conforms to spec:
* https://github.com/Microsoft/botbuilder-dotnet/blob/d342cd66d159a023ac435aec0fdf791f93118f5f/doc/UserAgents.md
* <p>
*
*/
public final class UserAgent {
// os/java and botbuilder will never change - static initialize once
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class AllowedCallersClaimsValidator extends ClaimsValidator {

/**
* Creates an instance of an {@link AllowedCallersClaimsValidator}.
* @param withAllowedCallers A List<String> that contains the list of allowed callers.
* @param withAllowedCallers A {@link List<String>} that contains the list of allowed callers.
*/
public AllowedCallersClaimsValidator(List<String> withAllowedCallers) {
this.allowedCallers = withAllowedCallers != null ? withAllowedCallers : new ArrayList<String>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ public static String getAppIdFromClaims(Map<String, String> claims) throws Illeg
/**
* Internal helper to check if the token has the shape we expect "Bearer [big long string]".
*
* @param authHeader >A string containing the token header.
* @param authHeader A string containing the token header.
* @return True if the token is valid, false if not.
*/
public static boolean isValidTokenFormat(String authHeader) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,18 +78,18 @@ public static boolean isSkillToken(String authHeader) {
/**
* Checks if the given list of claims represents a skill.
*
* A skill claim should contain: An {@link AuthenticationConstants#versionClaim}
* claim. An {@link AuthenticationConstants#audienceClaim} claim. An
* {@link AuthenticationConstants#appIdClaim} claim (v1) or an a
* {@link AuthenticationConstants#authorizedParty} claim (v2). And the appId
* A skill claim should contain: An {@link AuthenticationConstants.VERSION_CLAIM}
* claim. An {@link AuthenticationConstants.AUTIENCE_CLAIM} claim. An
* {@link AuthenticationConstants.APPID_CLAIM} claim (v1) or an a
* {@link AuthenticationConstants.AUTHORIZED_PARTY} claim (v2). And the appId
* claim should be different than the audience claim. When a channel (webchat,
* teams, etc.) invokes a bot, the {@link AuthenticationConstants#audienceClaim}
* is set to {@link AuthenticationConstants#toBotFromChannelTokenIssuer} but
* teams, etc.) invokes a bot, the {@link AuthenticationConstants.AUTIENCE_CLAIM}
* is set to {@link AuthenticationConstants.TO_BOT_FROM_CHANNEL_TOKEN_ISSUER} but
* when a bot calls another bot, the audience claim is set to the appId of the
* bot being invoked. The protocol supports v1 and v2 tokens: For v1 tokens, the
* {@link AuthenticationConstants#appIdClaim} is present and set to the app Id
* {@link AuthenticationConstants.APPID_CLAIM} is present and set to the app Id
* of the calling bot. For v2 tokens, the
* {@link AuthenticationConstants#authorizedParty} is present and set to the app
* {@link AuthenticationConstants.AUTHORIZED_PARTY} is present and set to the app
* Id of the calling bot.
*
* @param claims A list of claims.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,12 @@ public CompletableFuture<DialogTurnResult> continueDialog(DialogContext outerDc)
* If the task is successful, the result indicates whether this dialog
* is still active after this dialog turn has been processed. Generally,
* the child dialog was started with a call to
* {@link BeginDialog(DialogContext, Object)} in the parent's context.
* BeginDialog(DialogContext, Object) in the parent's context.
* However, if the {@link DialogContext#replaceDialog(String, Object)}
* method is called, the logical child dialog may be different than the
* original. If this method is *not* overridden, the dialog
* automatically calls its {@link RepromptDialog(TurnContext,
* DialogInstance)} when the user replies.
* automatically calls its RepromptDialog(TurnContext,
* DialogInstance) when the user replies.
*/
@Override
public CompletableFuture<DialogTurnResult> resumeDialog(DialogContext outerDc, DialogReason reason, Object result) {
Expand Down Expand Up @@ -277,7 +277,7 @@ protected CompletableFuture<Void> onInitialize(DialogContext dc) {
* default, this calls the
* {@link Dialog#beginDialog(DialogContext, Object)} method of the
* component dialog's initial dialog, as defined by
* {@link InitialDialogId} . Override this method in a derived class to
* InitialDialogId . Override this method in a derived class to
* implement interrupt logic.
*/
protected CompletableFuture<DialogTurnResult> onBeginDialog(DialogContext innerDc, Object options) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ public Dialog findDialog(String dialogId) {

/**
* @param name Name of the event to raise.
* @return CompletableFuture<Boolean>
* @return emitEvent
*/
public CompletableFuture<Boolean> emitEvent(String name) {
return emitEvent(name, null, true, false);
Expand All @@ -483,7 +483,7 @@ public CompletableFuture<Boolean> emitEvent(String name) {
* @param bubble Flag to control whether the event should be bubbled to its parent if not handled locally.
* Defaults to a value of `true`.
* @param fromLeaf Whether the event is emitted from a leaf node.
* @return CompletableFuture<Boolean>
* @return completedFuture
*/
public CompletableFuture<Boolean> emitEvent(String name, Object value, boolean bubble, boolean fromLeaf) {
// Initialize event
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ public void setStatus(DialogTurnStatus withStatus) {
* Gets or sets the result returned by a dialog that was just ended.
*
* <p>This will only be populated in certain cases:
* <br/>- The bot calls `DialogContext.BeginDialogAsync()` to start a new dialog and the dialog
* ends immediately.
* <br/>- The bot calls `DialogContext.ContinueDialogAsync()` and a dialog that was active ends.</p>
* <br>- The bot calls `DialogContext.BeginDialogAsync()` to start a new dialog and the dialog
* ends immediately.</br>
* <br>- The bot calls `DialogContext.ContinueDialogAsync()` and a dialog that was active ends.</br></p>
*
* <p>In all cases where it's populated, <see cref="DialogContext.ActiveDialog"/> will be `null`.</p>
* <p>In all cases where it's populated, {@link "DialogContext.ActiveDialog"} will be `null`.</p>
* @return The result returned by a dialog that was just ended.
*/
public Object getResult() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ public static <T> T mapValueTo(Object val, Class<T> valueType) {

/**
* Given an root Object and property path, resolve to a constant if eval = true or a constant path otherwise.
* conversation[user.name][user.age] => ['conversation', 'joe', 32].
* conversation[user.name][user.age] to ['conversation', 'joe', 32].
* @param <T> Type of T
* @param obj root Object.
* @param propertyPath property path to resolve.
Expand All @@ -501,7 +501,7 @@ public static <T> Segments tryResolvePath(Object obj, String propertyPath) {

/**
* Given an root Object and property path, resolve to a constant if eval = true or a constant path otherwise.
* conversation[user.name][user.age] => ['conversation', 'joe', 32].
* conversation[user.name][user.age] to ['conversation', 'joe', 32].
* @param <T> Type of T
* @param obj root Object.
* @param propertyPath property path to resolve.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public <T extends RecognizerConvert> CompletableFuture<T> recognize(
/**
* Returns ChooseIntent between multiple recognizer results.
*
* @param recognizerResults >recognizer Id => recognizer results map.
* @param recognizerResults recognizer Id to recognizer results map.
* @return recognizerResult which is ChooseIntent.
*/
protected static RecognizerResult createChooseIntentResult(Map<String, RecognizerResult> recognizerResults) {
Expand Down Expand Up @@ -219,7 +219,7 @@ public void setTelemetryClient(BotTelemetryClient withTelemetryClient) {
* @param recognizerResult Recognizer Result.
* @param telemetryProperties A list of properties to append or override the properties
* created using the RecognizerResult.
* @param dialogContext >Dialog Context.
* @param dialogContext Dialog Context.
* @return A dictionary that can be included when calling the TrackEvent method on the
* TelemetryClient.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
/**
* A specialized {@link Dialog} that can wrap remote calls to a skill.
*
* The options parameter in {@link BeginDialog} must be a
* The options parameter in BeginDialog must be a
* {@link BeginSkillDialogOptions} instancewith the initial parameters for the
* dialog.
*/
Expand Down Expand Up @@ -238,12 +238,12 @@ private CompletableFuture<Void> onEndDialog(TurnContext turnContext, DialogInsta
}

/**
* Validates the activity sent during {@link ContinueDialog} .
* Validates the activity sent during ContinueDialog .
*
* @param activity The {@link Activity} for the current turn of conversation.
*
* Override this method to implement a custom validator for the
* activity being sent during the {@link ContinueDialog} . This
* activity being sent during the ContinueDialog . This
* method can be used to ignore activities of a certain type if
* needed. If this method returns false, the dialog will end the
* turn without processing the activity.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.microsoft.bot.dialogs;

/**
* Exception used to report issues during the invoke method of the {@link SkillsDialog} class.
* Exception used to report issues during the invoke method of the {@link SkillDialog} class.
*/
public class SkillInvokeException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public WaterfallDialog addStep(WaterfallStep step) {
*
* @param dc The
* @param options Optional, initial information to pass to the dialog.
* @return A CompletableFuture<Void> representing the asynchronous operation.
* @return A CompletableFuture representing the asynchronous operation.
*
* If the task is successful, the result indicates whether the dialog is
* still active after the turn has been processed by the dialog.
Expand Down Expand Up @@ -110,7 +110,7 @@ public CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object
* dialog and the user replies with a new activity.
*
* @param dc The
* @return A CompletableFuture<Void> representing the asynchronous operation.
* @return A CompletableFuture representing the asynchronous operation.
*
* If the task is successful, the result indicates whether the dialog is
* still active after the turn has been processed by the dialog. The
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
import com.microsoft.bot.connector.Async;

/**
* Provides context for a step in a {@link waterfallDialog} .
* Provides context for a step in a {@link WaterfallDialog} .
*
* The {@link DialogContext#context} property contains the {@link TurnContext}
* The {@link DialogContext} property contains the {@link TurnContext}
* for the current turn.
*/
public class WaterfallStepContext extends DialogContext {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
* The DialogStateManager manages memory scopes and pathresolvers MemoryScopes
* are named root level Objects, which can exist either in the dialogcontext or
* off of turn state PathResolvers allow for shortcut behavior for mapping
* things like $foo -> dialog.foo.
* things like $foo to dialog.foo.
*/
public class DialogStateManager implements Map<String, Object> {

Expand Down Expand Up @@ -268,7 +268,7 @@ public String transformPath(String path) {
* clone of value).
*
* @param <TypeT> the value type to return.
* @param path >path expression to use.
* @param path path expression to use.
* @param clsType the Type that is being requested as a result
* @return ResultPair with boolean and requested type TypeT as a result
*/
Expand Down Expand Up @@ -503,7 +503,7 @@ public CompletableFuture<Void> saveAllChanges() {
* Delete the memory for a scope.
*
* @param name name of the scope
* @return Completed CompletableFuture<Void>
* @return Completed CompletableFuture
*/
public CompletableFuture<Void> deleteScopesMemory(String name) {
// Make a copy here that is final so it can be used in lamdba expression below
Expand Down Expand Up @@ -648,7 +648,7 @@ public Iterable<SimpleEntry<String, Object>> getEnumerator() {
* Track when specific paths are changed.
*
* @param paths Paths to track.
* @return Normalized paths to pass to AnyPathChanged/>.
* @return Normalized paths to pass to AnyPathChanged.
*/
public List<String> trackPaths(Iterable<String> paths) {
List<String> allPaths = new ArrayList<String>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class DialogStateManagerConfiguration {


/**
* @return List<PathResolver> Returns the list of PathResolvers.
* @return Returns the list of PathResolvers.
*/
public List<PathResolver> getPathResolvers() {
return this.pathResolvers;
Expand All @@ -35,7 +35,7 @@ public void setPathResolvers(List<PathResolver> withPathResolvers) {


/**
* @return List<MemoryScope> Returns the list of MemoryScopes.
* @return Returns the list of MemoryScopes.
*/
public List<MemoryScope> getMemoryScopes() {
return this.memoryScopes;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import com.microsoft.bot.dialogs.memory.PathResolver;

/**
* Maps aliasXXX -> path.xxx ($foo => dialog.foo).
* Maps aliasXXX to path.xxx ($foo to dialog.foo).
*/
public class AliasPathResolver implements PathResolver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package com.microsoft.bot.dialogs.memory.pathresolvers;

/**
* Maps @@ => turn.recognized.entitites.xxx array.
* Maps @@ to turn.recognized.entitites.xxx array.
*/
public class AtAtPathResolver extends AliasPathResolver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package com.microsoft.bot.dialogs.memory.pathresolvers;

/**
* Maps @@ => turn.recognized.entitites.xxx array.
* Maps @@ to turn.recognized.entitites.xxx array.
*/
public class AtPathResolver extends AliasPathResolver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package com.microsoft.bot.dialogs.memory.pathresolvers;

/**
* Maps #xxx => turn.recognized.intents.xxx.
* Maps #xxx to turn.recognized.intents.xxx.
*/
public class HashPathResolver extends AliasPathResolver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package com.microsoft.bot.dialogs.memory.pathresolvers;

/**
* Maps %xxx => settings.xxx (aka activeDialog.Instance.xxx).
* Maps %xxx to settings.xxx (aka activeDialog.Instance.xxx).
*/
public class PercentPathResolver extends AliasPathResolver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/
public class ConversationMemoryScope extends BotStateMemoryScope<ConversationState> {
/**
* DialogMemoryScope maps "this" -> dc.ActiveDialog.State.
* DialogMemoryScope maps "this" to dc.ActiveDialog.State.
*/
public ConversationMemoryScope() {
super(ConversationState.class, ScopePath.CONVERSATION);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import com.microsoft.bot.dialogs.ScopePath;

/**
* DialogContextMemoryScope maps "dialogcontext" -> properties.
* DialogContextMemoryScope maps "dialogcontext" to properties.
*/
public class DialogContextMemoryScope extends MemoryScope {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import com.microsoft.bot.dialogs.ScopePath;

/**
* DialogMemoryScope maps "dialog" -> dc.Parent?.ActiveDialog.State ?? ActiveDialog.State.
* DialogMemoryScope maps "dialog" to dc.Parent?.ActiveDialog.State ?? ActiveDialog.State.
*/
public class DialogMemoryScope extends MemoryScope {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public void setIncludeInSnapshot(Boolean withIncludeInSnapshot) {
* @param dialogContext The dialog context object for this turn.
* @param force True to overwrite any existing state cache or false to load state from storage only
* if the cache doesn't already exist.
* @return CompletableFuture<Void> A future that represents the work queued to execute.
* @return CompletableFuture A future that represents the work queued to execute.
*/
public CompletableFuture<Void> load(DialogContext dialogContext, Boolean force) {
return CompletableFuture.completedFuture(null);
Expand All @@ -95,7 +95,7 @@ public CompletableFuture<Void> load(DialogContext dialogContext, Boolean force)
* @param dialogContext The dialog context Object for this turn.
* @param force True to save the state cache to storage. or false to save state to storage only
* if a property in the cache has changed.
* @return CompletableFuture<Void> A future that represents the work queued to execute.
* @return CompletableFuture A future that represents the work queued to execute.
*/
public CompletableFuture<Void> saveChanges(DialogContext dialogContext, Boolean force) {
return CompletableFuture.completedFuture(null);
Expand All @@ -105,7 +105,7 @@ public CompletableFuture<Void> saveChanges(DialogContext dialogContext, Boolean
* Deletes any state in storage and the cache for this.
*
* @param dialogContext The dialog context Object for this turn.
* @return CompletableFuture<Void> A future that represents the work queued to execute.
* @return CompletableFuture A future that represents the work queued to execute.
*/
public CompletableFuture<Void> delete(DialogContext dialogContext) {
return CompletableFuture.completedFuture(null);
Expand Down
Loading